Make infra specs buildable again
To do this we drop the build_sphinx setup.py target as that is unusable with modern setuptools. Instead call sphinx directly in the tox docs target. Next we drop blockdiag and comment out the single blockdiag diagram as this plugin was never updated to work with modern Pillow (there is an argument mismatch and docs fail to build). Then we swap out the openstack docs theme and use the rtd docs theme. With added toctree captions this renders a nice navigation window (if a bit long vertically). Finally we do some small s/OpenStack/OpenDev/ updates but there is going to be much more to do later. Mostly I wanted to get this into a place where it builds and doesn't look completely wrong at first glance. Change-Id: Ieace28443258322ead25275f47fc6c9fbd23865f
This commit is contained in:
Clark Boylan
+1
-3
@@ -22,8 +22,6 @@ sys.path.insert(0, os.path.abspath('../..'))
|
||||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
||||
extensions = [
|
||||
'sphinxcontrib.blockdiag',
|
||||
'openstackdocstheme',
|
||||
'yasfb',
|
||||
]
|
||||
|
||||
@@ -74,7 +72,7 @@ pygments_style = 'sphinx'
|
||||
# html_theme_path = ["."]
|
||||
# html_theme = '_theme'
|
||||
# html_static_path = ['static']
|
||||
html_theme = 'openstackdocs'
|
||||
html_theme = 'sphinx_rtd_theme'
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = '%sdoc' % project
|
||||
|
||||
+98
-92
@@ -1,5 +1,5 @@
|
||||
========================================================
|
||||
OpenStack Project Infrastructure Design Specifications
|
||||
OpenDev Project Infrastructure Design Specifications
|
||||
========================================================
|
||||
|
||||
Priority Efforts
|
||||
@@ -9,16 +9,17 @@ These are the efforts we focus our review attention on first. They
|
||||
are a great way to get involved collaboratively with other
|
||||
infrastructure developers.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: Priority Efforts
|
||||
|
||||
specs/update-config-management
|
||||
specs/update-config-management
|
||||
|
||||
Gerrit query for all changes related to priority efforts::
|
||||
|
||||
status:open AND (topic:puppet-4 OR topic:update-cfg-mgmt)
|
||||
|
||||
https://review.openstack.org/#/q/(topic:puppet-4+OR+topic:update-cfg-mgmt)+AND+status:open
|
||||
https://review.opendev.org/#/q/(topic:puppet-4+OR+topic:update-cfg-mgmt)+AND+status:open
|
||||
|
||||
Approved Design Specifications
|
||||
==============================
|
||||
@@ -27,27 +28,28 @@ These are specifications that have been approved; work may or may not
|
||||
have started on these. Reviewers will review related changes as time
|
||||
permits.
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 1
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 1
|
||||
:caption: Approved Specs
|
||||
|
||||
specs/cleanup-test-node-python
|
||||
specs/deploy-ci-dashboard
|
||||
specs/jenkins-job-builder_2.0.0-api-changes
|
||||
specs/jitsi-meet
|
||||
specs/matrix
|
||||
specs/nodepool-drivers
|
||||
specs/puppet-module-functional-testing
|
||||
specs/refstack_dot_org
|
||||
specs/stackalytics
|
||||
specs/storyboard_story_attachments
|
||||
specs/storyboard_worklists_boards
|
||||
specs/survey
|
||||
specs/translation_check_site
|
||||
specs/wiki_modernization
|
||||
specs/website-stats
|
||||
specs/xwiki-farm
|
||||
specs/mailman3
|
||||
specs/cleanup-test-node-python
|
||||
specs/deploy-ci-dashboard
|
||||
specs/jenkins-job-builder_2.0.0-api-changes
|
||||
specs/jitsi-meet
|
||||
specs/matrix
|
||||
specs/nodepool-drivers
|
||||
specs/puppet-module-functional-testing
|
||||
specs/refstack_dot_org
|
||||
specs/stackalytics
|
||||
specs/storyboard_story_attachments
|
||||
specs/storyboard_worklists_boards
|
||||
specs/survey
|
||||
specs/translation_check_site
|
||||
specs/wiki_modernization
|
||||
specs/website-stats
|
||||
specs/xwiki-farm
|
||||
specs/mailman3
|
||||
|
||||
Help Wanted
|
||||
===========
|
||||
@@ -61,18 +63,19 @@ the associated spec adding themself as an assignee (and fleshing out
|
||||
additional details if necessary) while moving it into the approved
|
||||
section of this index.
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 1
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 1
|
||||
:caption: Help Wanted
|
||||
|
||||
specs/central-auth
|
||||
specs/irc
|
||||
specs/prometheus
|
||||
specs/storyboard_integration_tests
|
||||
specs/storyboard_story_tags
|
||||
specs/storyboard_subscription_pub_sub
|
||||
specs/storyboard_task_branches
|
||||
specs/zuulv3-3rd-party-ci
|
||||
specs/central-auth
|
||||
specs/irc
|
||||
specs/prometheus
|
||||
specs/storyboard_integration_tests
|
||||
specs/storyboard_story_tags
|
||||
specs/storyboard_subscription_pub_sub
|
||||
specs/storyboard_task_branches
|
||||
specs/zuulv3-3rd-party-ci
|
||||
|
||||
Implemented Design Specifications
|
||||
=================================
|
||||
@@ -80,53 +83,54 @@ Implemented Design Specifications
|
||||
These specifications have already been implemented and are listed here
|
||||
for historical purposes.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: Implemented Specs
|
||||
|
||||
specs/ansible_puppet_apply
|
||||
specs/apps-site
|
||||
specs/artifact-signing
|
||||
specs/branch-automation
|
||||
specs/centralize-release-tagging
|
||||
specs/code-search
|
||||
specs/complete-reviewable-release-automation
|
||||
specs/config-repo-split
|
||||
specs/deploy-stackviz
|
||||
specs/dib-nodepool
|
||||
specs/doc-publishing
|
||||
specs/ethercalc
|
||||
specs/firehose
|
||||
specs/gerrit-2.11
|
||||
specs/gerrit-2.13
|
||||
specs/gerrit-contactstore-removal
|
||||
specs/infra-cloud
|
||||
specs/letsencrypt
|
||||
specs/migrate_askbot
|
||||
specs/migrate_to_zanata
|
||||
specs/neutral-governance-website
|
||||
specs/newton-on-xenial
|
||||
specs/nodepool-workers
|
||||
specs/nodepool-zookeeper-workers
|
||||
specs/opendev-gerrit
|
||||
specs/openstackci
|
||||
specs/project-hosting
|
||||
specs/ptgbot
|
||||
specs/public_hiera
|
||||
specs/publish-election-repo
|
||||
specs/puppet_4_prelim_testing
|
||||
specs/puppet-modules
|
||||
specs/releases-openstack-org
|
||||
specs/retire-static
|
||||
specs/server_base_template_refactor
|
||||
specs/shade
|
||||
specs/task-tracker
|
||||
specs/test-metrics-db
|
||||
specs/translation_setup
|
||||
specs/trystack-site
|
||||
specs/unified_mirrors
|
||||
specs/zuul_split
|
||||
specs/zuulv3
|
||||
specs/zuulv3-executor-security
|
||||
specs/ansible_puppet_apply
|
||||
specs/apps-site
|
||||
specs/artifact-signing
|
||||
specs/branch-automation
|
||||
specs/centralize-release-tagging
|
||||
specs/code-search
|
||||
specs/complete-reviewable-release-automation
|
||||
specs/config-repo-split
|
||||
specs/deploy-stackviz
|
||||
specs/dib-nodepool
|
||||
specs/doc-publishing
|
||||
specs/ethercalc
|
||||
specs/firehose
|
||||
specs/gerrit-2.11
|
||||
specs/gerrit-2.13
|
||||
specs/gerrit-contactstore-removal
|
||||
specs/infra-cloud
|
||||
specs/letsencrypt
|
||||
specs/migrate_askbot
|
||||
specs/migrate_to_zanata
|
||||
specs/neutral-governance-website
|
||||
specs/newton-on-xenial
|
||||
specs/nodepool-workers
|
||||
specs/nodepool-zookeeper-workers
|
||||
specs/opendev-gerrit
|
||||
specs/openstackci
|
||||
specs/project-hosting
|
||||
specs/ptgbot
|
||||
specs/public_hiera
|
||||
specs/publish-election-repo
|
||||
specs/puppet_4_prelim_testing
|
||||
specs/puppet-modules
|
||||
specs/releases-openstack-org
|
||||
specs/retire-static
|
||||
specs/server_base_template_refactor
|
||||
specs/shade
|
||||
specs/task-tracker
|
||||
specs/test-metrics-db
|
||||
specs/translation_setup
|
||||
specs/trystack-site
|
||||
specs/unified_mirrors
|
||||
specs/zuul_split
|
||||
specs/zuulv3
|
||||
specs/zuulv3-executor-security
|
||||
|
||||
Abandoned Design Specifications
|
||||
===============================
|
||||
@@ -134,19 +138,21 @@ Abandoned Design Specifications
|
||||
These specifications had been approved previously but have not been
|
||||
implemented, they have been abandoned.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: Abandoned Specs
|
||||
|
||||
specs/logs-in-swift
|
||||
specs/maniphest
|
||||
specs/nodepool-launch-workers
|
||||
specs/pholio
|
||||
specs/logs-in-swift
|
||||
specs/maniphest
|
||||
specs/nodepool-launch-workers
|
||||
specs/pholio
|
||||
|
||||
Specifications Repository Information
|
||||
=====================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: Spec Repo Info
|
||||
|
||||
README <readme>
|
||||
contributing
|
||||
README <readme>
|
||||
contributing
|
||||
|
||||
+1
-2
@@ -4,8 +4,7 @@
|
||||
|
||||
pbr!=2.1.0,>2.0.0 # Apache-2.0
|
||||
|
||||
openstackdocstheme>=1.18.1 # Apache-2.0
|
||||
sphinx-rtd-theme
|
||||
sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
|
||||
sphinxcontrib-blockdiag==2.0.0 # BSD
|
||||
|
||||
yasfb>=0.5.1
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
[metadata]
|
||||
name = infra-specs
|
||||
summary = OpenStack Project Infrastructure Development Specifications
|
||||
description-file =
|
||||
description_file =
|
||||
README.rst
|
||||
author = OpenStack
|
||||
author-email = openstack-infra@lists.openstack.org
|
||||
home-page = http://www.openstack.org/
|
||||
author_email = service-discuss@lists.opendev.org
|
||||
home_page = https://opendev.org/
|
||||
classifier =
|
||||
Environment :: OpenStack
|
||||
Intended Audience :: Developers
|
||||
|
||||
@@ -42,7 +42,8 @@ Infra specific configuration, kept in `system-config
|
||||
and the more specific puppet modules which install and manage
|
||||
indivdual services.
|
||||
|
||||
.. blockdiag::
|
||||
.. Comment out the blockdiag as it no longer works with modern libs
|
||||
blockdiag::
|
||||
|
||||
diagram {
|
||||
|
||||
|
||||
Reference in New Issue
Block a user