Updating docs for v1.0.0b2

- Full cleanup of all the docs
- General sphinx housekeeping
- Updated all the old/bad links
- More reliable tests
- Updated Changelog
- Removed dead/deprecated code
- Added documentation generation test
This commit is contained in:
Jacob Alexander
2020-06-08 00:31:33 -07:00
parent 6532ca571d
commit 5e8ccba536
22 changed files with 752 additions and 328 deletions

View File

@@ -30,7 +30,12 @@ import capnp
# 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', 'sphinx.ext.viewcode', 'sphinx.ext.intersphinx']
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.viewcode',
'sphinx.ext.intersphinx',
'sphinx_multiversion',
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@@ -46,7 +51,7 @@ master_doc = 'index'
# General information about the project.
project = u'capnp'
copyright = u'2013, Author'
copyright = u'2013-2019 (Jason Paryani), 2019-2020 (Jacob Alexander)'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
@@ -128,7 +133,7 @@ html_theme = 'nature'
# 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,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
@@ -139,7 +144,7 @@ html_static_path = ['_static']
# html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
# html_sidebars = {}
html_sidebars = { '**': ['globaltoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html', 'versioning.html'] }
# Additional templates that should be rendered to pages, maps page names to
# template names.
@@ -293,3 +298,5 @@ epub_copyright = u'2013, Author'
# epub_tocdup = True
intersphinx_mapping = {'http://docs.python.org/': None}
smv_branch_whitelist = r'^master$'