diff --git a/.moban.d/custom_conf.py.jj2 b/.moban.d/custom_conf.py.jj2 index f9ecacdb..b4d9fd82 100644 --- a/.moban.d/custom_conf.py.jj2 +++ b/.moban.d/custom_conf.py.jj2 @@ -1,3 +1,3 @@ -{% include "docs/conf.py_t" %} +{% include "conf.py.jj2" %} -extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.viewcode'] \ No newline at end of file +master_doc = "index" \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index fe594daf..f9800022 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,3 +1,8 @@ +# -*- coding: utf-8 -*- +DESCRIPTION = ( + 'Yet another jinja2 cli command for static text generation' + + '' +) # Configuration file for the Sphinx documentation builder. # # This file only contains a selection of the most common options. For a full @@ -18,7 +23,7 @@ project = 'moban' copyright = '2017-2019 Onni Software Ltd. and its contributors' -author = 'C. W.' +author = 'Onni Software Ltd.' # The short X.Y version version = '0.4.1' # The full version, including alpha/beta/rc tags @@ -29,16 +34,17 @@ # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = [] +extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.viewcode',] # Add any paths that contain templates here, relative to this directory. -templates_path = ['templates'] +templates_path = ['_templates'] -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. # -# source_suffix = ['.rst', '.md'] -source_suffix = '' +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = 'en' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. @@ -56,5 +62,25 @@ # 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'] -extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.viewcode'] \ No newline at end of file +html_static_path = ['_static'] + +# -- Extension configuration ------------------------------------------------- +# -- Options for intersphinx extension --------------------------------------- + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = {'https://docs.python.org/': None} +# TODO: html_theme not configurable upstream +html_theme = 'default' + +# TODO: DESCRIPTION not configurable upstream +texinfo_documents = [ + ('index', 'moban', + 'moban Documentation', + 'Onni Software Ltd.', 'moban', + DESCRIPTION, + 'Miscellaneous'), +] +intersphinx_mapping.update({ +}) + +master_doc = "index" \ No newline at end of file