From ce80a35084023087d1344c9ca99fa6cbce1d5f43 Mon Sep 17 00:00:00 2001 From: Georgy Moiseev Date: Fri, 7 Oct 2022 15:39:59 +0300 Subject: [PATCH 1/2] doc: remove outdated upload script Remove script and make command for PyPi docs since module use readthedocs now. Part of #238 --- Makefile | 2 -- setup.py | 13 ------------- 2 files changed, 15 deletions(-) diff --git a/Makefile b/Makefile index 441d71d7..83e615b5 100644 --- a/Makefile +++ b/Makefile @@ -19,5 +19,3 @@ dist-upload-2: python setup.py sdist --format=ztar upload docs: python setup.py build_sphinx -docs-upload: docs - python setup.py upload_sphinx diff --git a/setup.py b/setup.py index f046309d..0ce35187 100755 --- a/setup.py +++ b/setup.py @@ -44,19 +44,6 @@ def run(self): pass -# Upload Sphinx documentation to PyPI (using Sphinx-PyPI-upload) -# python setup.py build_sphinx -# updates documentation at http://packages.python.org/tarantool/ -try: - from sphinx_pypi_upload import UploadDoc - cmdclass["upload_sphinx"] = UploadDoc - command_options["upload_sphinx"] = { - 'upload_dir': ('setup.py', os.path.join("build", "sphinx", "html")) - } -except ImportError: - pass - - # Test runner # python setup.py test try: From 56b7ebfe241c63653deda77989103086de19e0a4 Mon Sep 17 00:00:00 2001 From: Georgy Moiseev Date: Fri, 7 Oct 2022 15:36:47 +0300 Subject: [PATCH 2/2] doc: use readthedocs files structure Make structure similar to readthedocs tutorial [1]. 1. https://docs.readthedocs.io/en/stable/tutorial/ Part of #238 --- Makefile | 2 +- README.rst | 2 +- requirements-doc.txt => docs/requirements.txt | 0 .../_static/favicon/apple-touch-icon-114x114.png | Bin .../_static/favicon/apple-touch-icon-120x120.png | Bin .../_static/favicon/apple-touch-icon-144x144.png | Bin .../_static/favicon/apple-touch-icon-152x152.png | Bin .../_static/favicon/apple-touch-icon-57x57.png | Bin .../_static/favicon/apple-touch-icon-60x60.png | Bin .../_static/favicon/apple-touch-icon-72x72.png | Bin .../_static/favicon/apple-touch-icon-76x76.png | Bin .../source}/_static/favicon/generate-png.sh | 0 .../source}/_static/favicon/icon-128x128.png | Bin {doc => docs/source}/_static/favicon/icon-16x16.png | Bin .../source}/_static/favicon/icon-196x196.png | Bin {doc => docs/source}/_static/favicon/icon-32x32.png | Bin {doc => docs/source}/_static/favicon/icon-96x96.png | Bin {doc => docs/source}/_static/favicon/icon.svg | 0 {doc => docs/source}/api/module-tarantool.rst | 0 .../source}/api/submodule-connection-pool.rst | 0 {doc => docs/source}/api/submodule-connection.rst | 0 {doc => docs/source}/api/submodule-dbapi.rst | 0 {doc => docs/source}/api/submodule-error.rst | 0 .../source}/api/submodule-mesh-connection.rst | 0 .../source}/api/submodule-msgpack-ext-types.rst | 0 {doc => docs/source}/api/submodule-msgpack-ext.rst | 0 {doc => docs/source}/api/submodule-request.rst | 0 {doc => docs/source}/api/submodule-response.rst | 0 {doc => docs/source}/api/submodule-schema.rst | 0 {doc => docs/source}/api/submodule-space.rst | 0 {doc => docs/source}/api/submodule-utils.rst | 0 {doc => docs/source}/conf.py | 0 {doc => docs/source}/dev-guide.rst | 0 {doc => docs/source}/index.rst | 0 {doc => docs/source}/quick-start.rst | 0 35 files changed, 2 insertions(+), 2 deletions(-) rename requirements-doc.txt => docs/requirements.txt (100%) rename {doc => docs/source}/_static/favicon/apple-touch-icon-114x114.png (100%) rename {doc => docs/source}/_static/favicon/apple-touch-icon-120x120.png (100%) rename {doc => docs/source}/_static/favicon/apple-touch-icon-144x144.png (100%) rename {doc => docs/source}/_static/favicon/apple-touch-icon-152x152.png (100%) rename {doc => docs/source}/_static/favicon/apple-touch-icon-57x57.png (100%) rename {doc => docs/source}/_static/favicon/apple-touch-icon-60x60.png (100%) rename {doc => docs/source}/_static/favicon/apple-touch-icon-72x72.png (100%) rename {doc => docs/source}/_static/favicon/apple-touch-icon-76x76.png (100%) rename {doc => docs/source}/_static/favicon/generate-png.sh (100%) rename {doc => docs/source}/_static/favicon/icon-128x128.png (100%) rename {doc => docs/source}/_static/favicon/icon-16x16.png (100%) rename {doc => docs/source}/_static/favicon/icon-196x196.png (100%) rename {doc => docs/source}/_static/favicon/icon-32x32.png (100%) rename {doc => docs/source}/_static/favicon/icon-96x96.png (100%) rename {doc => docs/source}/_static/favicon/icon.svg (100%) rename {doc => docs/source}/api/module-tarantool.rst (100%) rename {doc => docs/source}/api/submodule-connection-pool.rst (100%) rename {doc => docs/source}/api/submodule-connection.rst (100%) rename {doc => docs/source}/api/submodule-dbapi.rst (100%) rename {doc => docs/source}/api/submodule-error.rst (100%) rename {doc => docs/source}/api/submodule-mesh-connection.rst (100%) rename {doc => docs/source}/api/submodule-msgpack-ext-types.rst (100%) rename {doc => docs/source}/api/submodule-msgpack-ext.rst (100%) rename {doc => docs/source}/api/submodule-request.rst (100%) rename {doc => docs/source}/api/submodule-response.rst (100%) rename {doc => docs/source}/api/submodule-schema.rst (100%) rename {doc => docs/source}/api/submodule-space.rst (100%) rename {doc => docs/source}/api/submodule-utils.rst (100%) rename {doc => docs/source}/conf.py (100%) rename {doc => docs/source}/dev-guide.rst (100%) rename {doc => docs/source}/index.rst (100%) rename {doc => docs/source}/quick-start.rst (100%) diff --git a/Makefile b/Makefile index 83e615b5..5d9f6382 100644 --- a/Makefile +++ b/Makefile @@ -1,4 +1,4 @@ -.PHONY: install test +.PHONY: install test docs install: pip install --editable . test: diff --git a/README.rst b/README.rst index e62407cc..44e14b0c 100644 --- a/README.rst +++ b/README.rst @@ -112,7 +112,7 @@ To build documentation, first you must install its build requirements: .. code-block:: bash - $ pip install -r requirements-doc.txt + $ pip install -r docs/requirements.txt Then run diff --git a/requirements-doc.txt b/docs/requirements.txt similarity index 100% rename from requirements-doc.txt rename to docs/requirements.txt diff --git a/doc/_static/favicon/apple-touch-icon-114x114.png b/docs/source/_static/favicon/apple-touch-icon-114x114.png similarity index 100% rename from doc/_static/favicon/apple-touch-icon-114x114.png rename to docs/source/_static/favicon/apple-touch-icon-114x114.png diff --git a/doc/_static/favicon/apple-touch-icon-120x120.png b/docs/source/_static/favicon/apple-touch-icon-120x120.png similarity index 100% rename from doc/_static/favicon/apple-touch-icon-120x120.png rename to docs/source/_static/favicon/apple-touch-icon-120x120.png diff --git a/doc/_static/favicon/apple-touch-icon-144x144.png b/docs/source/_static/favicon/apple-touch-icon-144x144.png similarity index 100% rename from doc/_static/favicon/apple-touch-icon-144x144.png rename to docs/source/_static/favicon/apple-touch-icon-144x144.png diff --git a/doc/_static/favicon/apple-touch-icon-152x152.png b/docs/source/_static/favicon/apple-touch-icon-152x152.png similarity index 100% rename from doc/_static/favicon/apple-touch-icon-152x152.png rename to docs/source/_static/favicon/apple-touch-icon-152x152.png diff --git a/doc/_static/favicon/apple-touch-icon-57x57.png b/docs/source/_static/favicon/apple-touch-icon-57x57.png similarity index 100% rename from doc/_static/favicon/apple-touch-icon-57x57.png rename to docs/source/_static/favicon/apple-touch-icon-57x57.png diff --git a/doc/_static/favicon/apple-touch-icon-60x60.png b/docs/source/_static/favicon/apple-touch-icon-60x60.png similarity index 100% rename from doc/_static/favicon/apple-touch-icon-60x60.png rename to docs/source/_static/favicon/apple-touch-icon-60x60.png diff --git a/doc/_static/favicon/apple-touch-icon-72x72.png b/docs/source/_static/favicon/apple-touch-icon-72x72.png similarity index 100% rename from doc/_static/favicon/apple-touch-icon-72x72.png rename to docs/source/_static/favicon/apple-touch-icon-72x72.png diff --git a/doc/_static/favicon/apple-touch-icon-76x76.png b/docs/source/_static/favicon/apple-touch-icon-76x76.png similarity index 100% rename from doc/_static/favicon/apple-touch-icon-76x76.png rename to docs/source/_static/favicon/apple-touch-icon-76x76.png diff --git a/doc/_static/favicon/generate-png.sh b/docs/source/_static/favicon/generate-png.sh similarity index 100% rename from doc/_static/favicon/generate-png.sh rename to docs/source/_static/favicon/generate-png.sh diff --git a/doc/_static/favicon/icon-128x128.png b/docs/source/_static/favicon/icon-128x128.png similarity index 100% rename from doc/_static/favicon/icon-128x128.png rename to docs/source/_static/favicon/icon-128x128.png diff --git a/doc/_static/favicon/icon-16x16.png b/docs/source/_static/favicon/icon-16x16.png similarity index 100% rename from doc/_static/favicon/icon-16x16.png rename to docs/source/_static/favicon/icon-16x16.png diff --git a/doc/_static/favicon/icon-196x196.png b/docs/source/_static/favicon/icon-196x196.png similarity index 100% rename from doc/_static/favicon/icon-196x196.png rename to docs/source/_static/favicon/icon-196x196.png diff --git a/doc/_static/favicon/icon-32x32.png b/docs/source/_static/favicon/icon-32x32.png similarity index 100% rename from doc/_static/favicon/icon-32x32.png rename to docs/source/_static/favicon/icon-32x32.png diff --git a/doc/_static/favicon/icon-96x96.png b/docs/source/_static/favicon/icon-96x96.png similarity index 100% rename from doc/_static/favicon/icon-96x96.png rename to docs/source/_static/favicon/icon-96x96.png diff --git a/doc/_static/favicon/icon.svg b/docs/source/_static/favicon/icon.svg similarity index 100% rename from doc/_static/favicon/icon.svg rename to docs/source/_static/favicon/icon.svg diff --git a/doc/api/module-tarantool.rst b/docs/source/api/module-tarantool.rst similarity index 100% rename from doc/api/module-tarantool.rst rename to docs/source/api/module-tarantool.rst diff --git a/doc/api/submodule-connection-pool.rst b/docs/source/api/submodule-connection-pool.rst similarity index 100% rename from doc/api/submodule-connection-pool.rst rename to docs/source/api/submodule-connection-pool.rst diff --git a/doc/api/submodule-connection.rst b/docs/source/api/submodule-connection.rst similarity index 100% rename from doc/api/submodule-connection.rst rename to docs/source/api/submodule-connection.rst diff --git a/doc/api/submodule-dbapi.rst b/docs/source/api/submodule-dbapi.rst similarity index 100% rename from doc/api/submodule-dbapi.rst rename to docs/source/api/submodule-dbapi.rst diff --git a/doc/api/submodule-error.rst b/docs/source/api/submodule-error.rst similarity index 100% rename from doc/api/submodule-error.rst rename to docs/source/api/submodule-error.rst diff --git a/doc/api/submodule-mesh-connection.rst b/docs/source/api/submodule-mesh-connection.rst similarity index 100% rename from doc/api/submodule-mesh-connection.rst rename to docs/source/api/submodule-mesh-connection.rst diff --git a/doc/api/submodule-msgpack-ext-types.rst b/docs/source/api/submodule-msgpack-ext-types.rst similarity index 100% rename from doc/api/submodule-msgpack-ext-types.rst rename to docs/source/api/submodule-msgpack-ext-types.rst diff --git a/doc/api/submodule-msgpack-ext.rst b/docs/source/api/submodule-msgpack-ext.rst similarity index 100% rename from doc/api/submodule-msgpack-ext.rst rename to docs/source/api/submodule-msgpack-ext.rst diff --git a/doc/api/submodule-request.rst b/docs/source/api/submodule-request.rst similarity index 100% rename from doc/api/submodule-request.rst rename to docs/source/api/submodule-request.rst diff --git a/doc/api/submodule-response.rst b/docs/source/api/submodule-response.rst similarity index 100% rename from doc/api/submodule-response.rst rename to docs/source/api/submodule-response.rst diff --git a/doc/api/submodule-schema.rst b/docs/source/api/submodule-schema.rst similarity index 100% rename from doc/api/submodule-schema.rst rename to docs/source/api/submodule-schema.rst diff --git a/doc/api/submodule-space.rst b/docs/source/api/submodule-space.rst similarity index 100% rename from doc/api/submodule-space.rst rename to docs/source/api/submodule-space.rst diff --git a/doc/api/submodule-utils.rst b/docs/source/api/submodule-utils.rst similarity index 100% rename from doc/api/submodule-utils.rst rename to docs/source/api/submodule-utils.rst diff --git a/doc/conf.py b/docs/source/conf.py similarity index 100% rename from doc/conf.py rename to docs/source/conf.py diff --git a/doc/dev-guide.rst b/docs/source/dev-guide.rst similarity index 100% rename from doc/dev-guide.rst rename to docs/source/dev-guide.rst diff --git a/doc/index.rst b/docs/source/index.rst similarity index 100% rename from doc/index.rst rename to docs/source/index.rst diff --git a/doc/quick-start.rst b/docs/source/quick-start.rst similarity index 100% rename from doc/quick-start.rst rename to docs/source/quick-start.rst