Browse Source

Doc Cleanups

* Update to newer openstackdocstheme, remove settings from conf.py that
  are default now.
* Remove unused autodoc extension.
* Remove unused and obsolete settings from setup.cfg

Change-Id: I5ea6c5ecb7325ebbb03f1baf476117db16bed46e
changes/59/709359/1
Andreas Jaeger 1 year ago
parent
commit
a8f8472b32
3 changed files with 3 additions and 35 deletions
  1. +2
    -21
      doc/source/conf.py
  2. +1
    -2
      requirements.txt
  3. +0
    -12
      setup.cfg

+ 2
- 21
doc/source/conf.py View File

@ -12,11 +12,9 @@
# serve to show the default.
import datetime
import subprocess
import sys
import os
import openstackdocstheme
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
@ -30,7 +28,7 @@ import openstackdocstheme
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc',
extensions = [
'sphinx.ext.todo',
'sphinx.ext.viewcode',
'openstackdocstheme',
@ -117,7 +115,7 @@ html_theme = 'openstackdocs'
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = [openstackdocstheme.get_html_theme_path()]
# html_theme_path = [openstackdocstheme.get_html_theme_path()]
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
@ -140,12 +138,6 @@ html_theme_path = [openstackdocstheme.get_html_theme_path()]
# so a file named "default.css" will overwrite the builtin "default.css".
# html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
git_cmd = ["git", "log", "--pretty=format:'%ad, commit %h'", "--date=local",
"-n1"]
html_last_updated_fmt = subprocess.check_output(git_cmd).decode('utf-8')
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
@ -189,17 +181,6 @@ htmlhelp_basename = 'QA-Specsdoc'
# -- Options for LaTeX output --------------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#'preamble': '',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [


+ 1
- 2
requirements.txt View File

@ -1,6 +1,5 @@
pbr>=1.6 # Apache-2.0
docutils>=0.11,!=0.13.1 # OSI-Approved Open Source, Public Domain
oslosphinx>=4.7.0 # Apache-2.0
sphinx>=1.6.2 # BSD
yasfb>=0.5.1
openstackdocstheme>=1.5.0 # Apache-2.0
openstackdocstheme>=1.31.2 # Apache-2.0

+ 0
- 12
setup.cfg View File

@ -10,15 +10,3 @@ classifier =
Intended Audience :: Developers
License :: OSI Approved :: Apache Software License
Operating System :: POSIX :: Linux
[build_sphinx]
all_files = 1
build-dir = doc/build
source-dir = doc/source
warning-is-error = 1
[pbr]
warnerrors = True
[wheel]
universal = 1

Loading…
Cancel
Save