openstack/mistral-dashboard
Code Issues Proposed changes

Replace retired oslosphinx

Browse Source 
The oslosphinx project[1] was retired. Replace it by openstackdocstheme
which is commonly used now.

[1] https://github.com/openstack-archive/oslosphinx

Change-Id: I1b9d0ec98bf99ea3d20ff1987acabe0192aae0c4
This commit is contained in:
Takashi Kajinami
2024-05-07 18:41:13 +09:00
parent 7114feec84
commit ad1f7942b0
4 changed files with 6 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/requirements.txt
View File

@@ -1,4 +1,4 @@
openstackdocstheme>=2.2.1 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD sphinx>=2.0.0,!=2.1.0 # BSD
oslosphinx>=4.7.0 # Apache-2.0
reno>=3.1.0 # Apache-2.0 reno>=3.1.0 # Apache-2.0
docutils>=0.11 # OSI-Approved Open Source, Public Domain docutils>=0.11 # OSI-Approved Open Source, Public Domain

4
doc/source/conf.py
View File

@@ -22,7 +22,7 @@ sys.path.insert(0, os.path.abspath('../..'))
extensions = [ extensions = [
'sphinx.ext.autodoc', 'sphinx.ext.autodoc',
'sphinx.ext.intersphinx', 'sphinx.ext.intersphinx',
'oslosphinx', 'openstackdocstheme',
] ]
# autodoc generation is a bit aggressive and a nuisance when doing heavy # autodoc generation is a bit aggressive and a nuisance when doing heavy
@@ -60,7 +60,7 @@ pygments_style = 'native'
# The theme to use for HTML and HTML Help pages. Major themes that come with # The theme to use for HTML and HTML Help pages. Major themes that come with
# Sphinx are currently 'default' and 'sphinxdoc'. # Sphinx are currently 'default' and 'sphinxdoc'.
# html_theme_path = ["."] # html_theme_path = ["."]
# html_theme = '_theme' html_theme = 'openstackdocs'
# html_static_path = [] # html_static_path = []
# Output file base name for HTML help builder. # Output file base name for HTML help builder.

2
doc/source/index.rst
View File

@@ -1,6 +1,6 @@
Welcome to Mistral Dashboard's documentation! Welcome to Mistral Dashboard's documentation!
============================================ =============================================
Contents: Contents:

7
releasenotes/source/conf.py
View File

@@ -11,16 +11,12 @@
# See the License for the specific language governing permissions and # See the License for the specific language governing permissions and
# limitations under the License. # limitations under the License.
import os
import sys
sys.path.insert(0, os.path.abspath('../..'))
# -- General configuration ---------------------------------------------------- # -- General configuration ----------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be # Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [ extensions = [
'oslosphinx', 'openstackdocstheme',
'reno.sphinxext', 'reno.sphinxext',
] ]
@@ -60,6 +56,7 @@ pygments_style = 'native'
# Sphinx are currently 'default' and 'sphinxdoc'. # Sphinx are currently 'default' and 'sphinxdoc'.
# html_theme_path = ["."] # html_theme_path = ["."]
# html_theme = '_theme' # html_theme = '_theme'
html_theme = 'openstackdocs'
# html_static_path = [] # html_static_path = []
# Output file base name for HTML help builder. # Output file base name for HTML help builder.