diff --git a/doc/source/archive/building_and_deploying_docker_images.rst b/doc/source/archive/building_and_deploying_docker_images.rst index b35223a1..4bcc4625 100644 --- a/doc/source/archive/building_and_deploying_docker_images.rst +++ b/doc/source/archive/building_and_deploying_docker_images.rst @@ -1,3 +1,5 @@ +:orphan: + Introduction ============ The Swift account manager can supply a Docker image in which the account's storlets diff --git a/doc/source/archive/invoking_storlets.rst b/doc/source/archive/invoking_storlets.rst index f1fae6c2..796eeb40 100644 --- a/doc/source/archive/invoking_storlets.rst +++ b/doc/source/archive/invoking_storlets.rst @@ -1,3 +1,5 @@ +:orphan: + =================== Storlets Invocation =================== diff --git a/doc/source/archive/storlet_api.rst b/doc/source/archive/storlet_api.rst index b7543710..948f6cd3 100644 --- a/doc/source/archive/storlet_api.rst +++ b/doc/source/archive/storlet_api.rst @@ -1,3 +1,5 @@ +:orphan: + =============== Storlets API v1 =============== diff --git a/doc/source/archive/storlets_docker_gateway.rst b/doc/source/archive/storlets_docker_gateway.rst index 8a72fbb5..febbeb63 100644 --- a/doc/source/archive/storlets_docker_gateway.rst +++ b/doc/source/archive/storlets_docker_gateway.rst @@ -1,3 +1,5 @@ +:orphan: + ===================== StorletsDockerGateway ===================== diff --git a/doc/source/archive/storlets_management.rst b/doc/source/archive/storlets_management.rst index bc279cac..21c8a5d6 100644 --- a/doc/source/archive/storlets_management.rst +++ b/doc/source/archive/storlets_management.rst @@ -1,3 +1,5 @@ +:orphan: + ============ Introduction ============ diff --git a/doc/source/index.rst b/doc/source/index.rst index 1527274d..29532c06 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -52,6 +52,7 @@ Overview and Concepts storlet_engine_overview api/overview_api ipython_integration + installation Related Projects ~~~~~~~~~~~~~~~~ @@ -71,6 +72,7 @@ Storlets Developers .. toctree:: :maxdepth: 1 + contributing writing_and_deploying_storlets writing_and_deploying_java_storlets writing_and_deploying_python_storlets diff --git a/doc/source/ipython_integration.rst b/doc/source/ipython_integration.rst index df9c0f95..6462137d 100644 --- a/doc/source/ipython_integration.rst +++ b/doc/source/ipython_integration.rst @@ -8,9 +8,9 @@ Set up IPython to work with storlets Setting up an IPython notebook to work with storlets involves: #. Providing the authentication information of a storlet enabled Swift account. - This is done by setting environment variables similar to those used by swift - client. The exact variables that need to be set are dependent on the auth middleware - used and the auth protocol version. For more details please refer to: + This is done by setting environment variables similar to those used by swift + client. The exact variables that need to be set are dependent on the auth middleware + used and the auth protocol version. For more details please refer to: `python-swiftclient docs `_. diff --git a/doc/source/readme.rst b/doc/source/readme.rst index a6210d3d..02b3d2fd 100644 --- a/doc/source/readme.rst +++ b/doc/source/readme.rst @@ -1 +1,3 @@ +:orphan: + .. include:: ../../README.rst diff --git a/setup.cfg b/setup.cfg index d83d1eac..cda5c2ff 100644 --- a/setup.cfg +++ b/setup.cfg @@ -6,6 +6,7 @@ description-file = author = OpenStack author-email = openstack-discuss@lists.openstack.org home-page = https://docs.openstack.org/storlets/latest/ +python-requires = >=3.6 classifier = Environment :: OpenStack Intended Audience :: Information Technology @@ -13,6 +14,8 @@ classifier = License :: OSI Approved :: Apache Software License Operating System :: POSIX :: Linux Programming Language :: Python + Programming Language :: Python :: Implementation :: CPython + Programming Language :: Python :: 3 :: Only Programming Language :: Python :: 3 Programming Language :: Python :: 3.6 Programming Language :: Python :: 3.7 @@ -38,14 +41,6 @@ console_scripts = storlets-daemon = storlets.agent.daemon.server:main storlets-daemon-factory = storlets.agent.daemon_factory.server:main -[build_sphinx] -source-dir = doc/source -build-dir = doc/build -all_files = 1 - -[upload_sphinx] -upload-dir = doc/build/html - [compile_catalog] directory = storlets/locale domain = storlets diff --git a/setup.py b/setup.py index 291da5da..341ac71c 100644 --- a/setup.py +++ b/setup.py @@ -13,17 +13,8 @@ # See the License for the specific language governing permissions and # limitations under the License. -# THIS FILE IS MANAGED BY THE GLOBAL REQUIREMENTS REPO - DO NOT EDIT import setuptools -# In python < 2.7.4, a lazy loading of package `pbr` will break -# setuptools if some other modules registered functions in `atexit`. -# solution from: http://bugs.python.org/issue15881#msg170215 -try: - import multiprocessing # noqa -except ImportError: - pass - setuptools.setup( setup_requires=['pbr>=1.9', 'setuptools>=17.1'], pbr=True) diff --git a/tox.ini b/tox.ini index fe2d4fdb..8b32074c 100644 --- a/tox.ini +++ b/tox.ini @@ -63,7 +63,8 @@ commands = coverage xml -o cover/coverage.xml [testenv:docs] -commands = python setup.py build_sphinx +commands = + sphinx-build -a -W -E -b html doc/source doc/build/html [testenv:debug] commands = oslo_debug_helper {posargs}