Skip to content

Commit 8dd89e5

Browse files
committed
Update docs building
Switch to "modern" way of building docs using sphinx-build directly, remove now unsed parts from setup.cfg. Upgrade to openstackdocstheme 1.20 and remove obsolete variables from conf.py. Convert external links to internal RST links so that Sphinx can verify that they are correct. Replace redirected links with new targets. Use opendev.org instead of github.com where appropriate. Change-Id: Iedcc008b170821aa74acefc02ec6a243a0dc307c
1 parent c9abbf5 commit 8dd89e5

13 files changed

Lines changed: 20 additions & 42 deletions

HACKING.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ to enforce basic guidelines, similar to pep8 and flake8 tools for Python. The
189189
list below is not complete for what bashate checks, nor is it all checked
190190
by bashate. So many lines of code, so little time.
191191

192-
.. _bashate: https://pypi.python.org/pypi/bashate
192+
.. _bashate: https://pypi.org/project/bashate/
193193

194194
Whitespace Rules
195195
----------------

doc/requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ pbr>=2.0.0,!=2.1.0
33
Pygments
44
docutils
55
sphinx>=1.6.2
6-
openstackdocstheme>=1.11.0
6+
openstackdocstheme>=1.20.0
77
nwdiag
88
blockdiag
99
sphinxcontrib-blockdiag

doc/source/conf.py

Lines changed: 5 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,6 @@
1111
# All configuration values have a default; values that are commented out
1212
# serve to show the default.
1313

14-
import sys
15-
import os
16-
1714
# If extensions (or modules to document with autodoc) are in another directory,
1815
# add these directories to sys.path here. If the directory is relative to the
1916
# documentation root, use os.path.abspath to make it absolute, like shown here.
@@ -26,13 +23,16 @@
2623

2724
# Add any Sphinx extension module names here, as strings. They can be extensions
2825
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
29-
extensions = [ 'sphinx.ext.autodoc', 'zuul_sphinx', 'openstackdocstheme', 'sphinxcontrib.blockdiag', 'sphinxcontrib.nwdiag' ]
26+
extensions = [ 'sphinx.ext.autodoc',
27+
'zuul_sphinx',
28+
'openstackdocstheme',
29+
'sphinxcontrib.blockdiag',
30+
'sphinxcontrib.nwdiag' ]
3031

3132
# openstackdocstheme options
3233
repository_name = 'openstack-dev/devstack'
3334
bug_project = 'devstack'
3435
bug_tag = ''
35-
html_last_updated_fmt = '%Y-%m-%d %H:%M'
3636

3737
todo_include_todos = True
3838

@@ -119,11 +119,6 @@
119119
# pixels large.
120120
#html_favicon = None
121121

122-
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
123-
# using the given strftime format.
124-
git_cmd = "git log --pretty=format:'%ad, commit %h' --date=local -n1"
125-
html_last_updated_fmt = os.popen(git_cmd).read()
126-
127122
# If true, SmartyPants will be used to convert quotes and dashes to
128123
# typographically correct entities.
129124
#html_use_smartypants = True
@@ -167,17 +162,6 @@
167162

168163
# -- Options for LaTeX output --------------------------------------------------
169164

170-
latex_elements = {
171-
# The paper size ('letterpaper' or 'a4paper').
172-
#'papersize': 'letterpaper',
173-
174-
# The font size ('10pt', '11pt' or '12pt').
175-
#'pointsize': '10pt',
176-
177-
# Additional stuff for the LaTeX preamble.
178-
#'preamble': '',
179-
}
180-
181165
# Grouping the document tree into LaTeX files. List of tuples
182166
# (source start file, target name, title, author, documentclass [howto/manual]).
183167
latex_documents = [

doc/source/configuration.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -259,6 +259,8 @@ changed from the default value.
259259
Logging
260260
-------
261261

262+
.. _enable_logging:
263+
262264
Enable Logging
263265
~~~~~~~~~~~~~~
264266

@@ -495,7 +497,7 @@ should be specified in the configuration file so Tempest selects the
495497
default flavors instead.
496498

497499
KVM on Power with QEMU 2.4 requires 512 MB to load the firmware -
498-
`QEMU 2.4 - PowerPC <http://wiki.qemu.org/ChangeLog/2.4>`__ so users
500+
`QEMU 2.4 - PowerPC <https://wiki.qemu.org/ChangeLog/2.4>`__ so users
499501
running instances on ppc64/ppc64le can choose one of the default
500502
created flavors as follows:
501503

doc/source/guides/devstack-with-lbaas-v2.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Edit your ``/opt/stack/devstack/local.conf`` to look like
3939
# If you are enabling horizon, include the octavia dashboard
4040
# enable_plugin octavia-dashboard https://opendev.org/openstack/octavia-dashboard.git
4141
# If you are enabling barbican for TLS offload in Octavia, include it here.
42-
# enable_plugin barbican https://github.com/openstack/barbican.git
42+
# enable_plugin barbican https://opendev.org/openstack/barbican
4343

4444
# If you have python3 available:
4545
# USE_PYTHON3=True

doc/source/guides/nova.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ nova-serialproxy
1010
================
1111

1212
In Juno, nova implemented a `spec
13-
<http://specs.openstack.org/openstack/nova-specs/specs/juno/implemented/serial-ports.html>`_
13+
<https://specs.openstack.org/openstack/nova-specs/specs/juno/implemented/serial-ports.html>`_
1414
to allow read/write access to the serial console of an instance via
1515
`nova-serialproxy
1616
<https://docs.openstack.org/nova/latest/cli/nova-serialproxy.html>`_.
@@ -63,7 +63,7 @@ The service can be enabled by adding ``n-sproxy`` to
6363
Enabling the service is enough to be functional for a single machine DevStack.
6464

6565
These config options are defined in `nova.conf.serial_console
66-
<https://github.com/openstack/nova/blob/master/nova/conf/serial_console.py>`_.
66+
<https://opendev.org/openstack/nova/src/master/nova/conf/serial_console.py>`_.
6767

6868
For more information on OpenStack configuration see the `OpenStack
6969
Compute Service Configuration Reference

doc/source/guides/single-vm.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ As DevStack will refuse to run as root, this configures ``cloud-init``
7878
to create a non-root user and run the ``start.sh`` script as that user.
7979

8080
If you are using cloud-init and you have not
81-
`enabled custom logging <../configuration.html#enable-logging>`_ of the stack
81+
:ref:`enabled custom logging <enable_logging>` of the stack
8282
output, then the stack output can be found in
8383
``/var/log/cloud-init-output.log`` by default.
8484

doc/source/plugins.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -332,6 +332,6 @@ See Also
332332
========
333333

334334
For additional inspiration on devstack plugins you can check out the
335-
`Plugin Registry <plugin-registry.html>`_.
335+
:doc:`Plugin Registry <plugin-registry>`.
336336

337337
.. _service types authority: https://specs.openstack.org/openstack/service-types-authority/

doc/source/systemd.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,7 @@ Telnet to that port to enter the pdb session::
194194

195195
See the `remote-pdb`_ home page for more options.
196196

197-
.. _`remote-pdb`: https://pypi.python.org/pypi/remote-pdb
197+
.. _`remote-pdb`: https://pypi.org/project/remote-pdb/
198198

199199
Known Issues
200200
============

doc/source/zuul_ci_jobs_migration.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ DEVSTACK_GATE_NET_OVERLAY zuul-jobs A bridge called
190190
br-infra is set up for
191191
all jobs that inherit
192192
from multinode with
193-
a dedicated `bridge role <https://docs.openstack.org/infra/zuul-jobs/roles.html#role-multi-node-bridge>`_.
193+
a dedicated `bridge role <https://zuul-ci.org/docs/zuul-jobs/general-roles.html#role-multi-node-bridge>`_.
194194
DEVSTACK_GATE_FEATURE_MATRIX devstack-gate ``test_matrix_features``
195195
variable of the
196196
test-matrix role in

0 commit comments

Comments
 (0)