Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOP-11710] Move documentation to ReadTheDocs #25

Merged
merged 9 commits into from
Mar 28, 2024
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ SyncMaster
.. |Docker image| image:: https://img.shields.io/docker/v/mtsrus/syncmaster-backend?sort=semver&label=docker
:target: https://hub.docker.com/r/mtsrus/syncmaster-backend
.. |Documentation| image:: https://readthedocs.org/projects/data-syncmaster/badge/?version=stable
:target: https://data-syncmaster.readthedocs.io/
:target: https://syncmaster.readthedocs.io
.. |Build Status| image:: https://github.com/MobileTeleSystems/syncmaster/workflows/Tests/badge.svg
:target: https://github.com/MobileTeleSystems/syncmaster/actions
.. |Coverage| image:: https://codecov.io/gh/MobileTeleSystems/syncmaster/graph/badge.svg?token=ky7UyUxolB
Expand Down Expand Up @@ -63,4 +63,4 @@ Non-goals
Documentation
-------------

See https://data-syncmaster.readthedocs.io/
See https://syncmaster.readthedocs.io
3 changes: 3 additions & 0 deletions docs/_static/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.logo {
width: 200px !important;
}
9 changes: 9 additions & 0 deletions docs/_static/openapi.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"openapi": "3.1.0",
"version": "unknown",
"info": {
"title": "Generated in CI",
"version": "unknown"
},
"paths": {}
}
28 changes: 28 additions & 0 deletions docs/_static/redoc.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@

<!DOCTYPE html>
<html>
<head>
<title>SyncMaster - ReDoc</title>
<!-- needed for adaptive design -->
<meta charset="utf-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1">

<link rel="shortcut icon" href="../_static/icon.svg">
<!--
ReDoc doesn't change outer page styles
-->
<style>
body {
margin: 0;
padding: 0;
}
</style>
</head>
<body>
<noscript>
ReDoc requires Javascript to function. Please enable it to browse the documentation.
</noscript>
<redoc spec-url="../_static/openapi.json"></redoc>
<script src="https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js"></script>
</body>
</html>
26 changes: 26 additions & 0 deletions docs/_static/swagger.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta
name="description"
content="SwaggerUI"
/>
<title>SwaggerUI</title>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/swagger-ui-dist@5/swagger-ui.css" />
<link rel="shortcut icon" href="../_static/icon.svg">
</head>
<body>
<div id="swagger-ui"></div>
<script src="https://cdn.jsdelivr.net/npm/swagger-ui-dist@5/swagger-ui-bundle.js" crossorigin></script>
<script>
window.onload = () => {
window.ui = SwaggerUIBundle({
url: '../_static/openapi.json',
dom_id: '#swagger-ui',
});
};
</script>
</body>
</html>
4 changes: 2 additions & 2 deletions docs/design/permissions.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _role-permissions:

Roles and rules
===============
Roles and permissions
=====================

- Object within the group can be seen/interacted with only by users which are members of the group.
- Permissions are limited by role assigned to user within specific group.
Expand Down
2 changes: 0 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
.. include:: ../README.rst

.. include:: ../README.rst

.. toctree::
:maxdepth: 2
:caption: High-level design
Expand Down
19 changes: 18 additions & 1 deletion poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ exclude = [

[tool.poetry.urls] # Optional
"Homepage" = "https://github.com/MobileTeleSystems/syncmaster"
"Documentation" = "https://syncmaster.readthedocs.io"
"Source" = "https://github.com/MobileTeleSystems/syncmaster"
"CI/CD" = "https://github.com/MobileTeleSystems/syncmaster/actions"
"Tracker" = "https://github.com/MobileTeleSystems/syncmaster/issues"
Expand Down Expand Up @@ -210,6 +211,7 @@ towncrier = {version = "^23.11.0", python = ">=3.8"}
sphinx-issues = {version = ">=3.0.1,<5.0.0", python = ">=3.8"}
sphinx-design = {version = "^0.5.0", python = ">=3.8"}
sphinx-favicon = {version = "^1.0.1", python = ">=3.8"}
sphinx-argparse = {version = "^0.2.5", python = ">=3.8"}
# uncomment after https://github.com/zqmillet/sphinx-plantuml/pull/4
# sphinx-plantuml = {version = "^1.0.0", python = ">=3.8"}

Expand Down