With a Sphinx project auto-generated, configure it to be something a bit
more useful. And pretty.
Signed-off-by: John Snow <js...@redhat.com>
---
docs/conf.py | 45 ++++++++++++++++++++++++++++++++++++---------
1 file changed, 36 insertions(+), 9 deletions(-)
diff --git a/docs/conf.py b/docs/conf.py
index c7ce779..7db99c2 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -9,18 +9,28 @@
# 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
# documentation root, use os.path.abspath to make it absolute, like shown here.
-#
-# import os
-# import sys
-# sys.path.insert(0, '/home/jsnow/src/tmp/qemu.qmp/qemu')
+
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../'))
# -- Project information -----------------------------------------------------
-project = 'qemu'
-copyright = '2021, Author'
-author = 'Author'
+project = 'QEMU Monitor Protocol (QMP) Library'
+copyright = '2009-2021, QEMU Project'
+author = 'John Snow'
+try:
+ import setuptools_scm
+ extracted_version = setuptools_scm.get_version()
+except:
+ extracted_version = None
+finally:
+ if extracted_version:
+ version = release = extracted_version
+ else:
+ version = release = "unknown version"
# -- General configuration ---------------------------------------------------
@@ -51,13 +61,30 @@ language = 'en'
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+# Interpret `this` to be a cross-reference to "anything".
+default_role = 'any'
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
-html_theme = 'alabaster'
+html_theme = 'sphinx_rtd_theme'
+
+#
https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html#theme-options
+html_theme_options = {
+ 'collapse_navigation': False,
+ 'display_version': True,
+ 'prev_next_buttons_location': 'both',
+}
+
+html_context = {
+ "display_gitlab": True,
+ "gitlab_user": "jsnow",
+ "gitlab_repo": "qemu.qmp",
+ "gitlab_version": "main",
+ "conf_py_path": "/docs/",
+}
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
@@ -77,4 +104,4 @@ intersphinx_mapping = {
# -- Options for todo extension ----------------------------------------------
# If true, `todo` and `todoList` produce output, else they produce nothing.
-todo_include_todos = True
\ No newline at end of file
+todo_include_todos = True
--
2.31.1
