diff --git a/source/_static/favicon.ico b/source/_static/favicon.ico new file mode 100644 index 0000000..88d2b6b Binary files /dev/null and b/source/_static/favicon.ico differ diff --git a/source/_templates/layout.html b/source/_templates/layout.html index c1ee910..5aaf773 100644 --- a/source/_templates/layout.html +++ b/source/_templates/layout.html @@ -10,4 +10,12 @@ gtag('js', new Date()); gtag('config', '{{ googleanalytics_id }}'); +{% endblock %} + + {% block footer %} {{ super() }} + + + {% endblock %} \ No newline at end of file diff --git a/source/conf.py b/source/conf.py index 9d4396c..6689fc0 100644 --- a/source/conf.py +++ b/source/conf.py @@ -21,6 +21,9 @@ exclude_patterns = ['**/.git', 'Thumbs.db', '**/.venv', '**/.idea', '**/.mypy_ca googleanalytics_id = 'UA-122962025-6' # Provided by Google in your dashboard and need for html context below. +# The master toctree document. +master_doc = 'contents' + # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output @@ -45,13 +48,13 @@ html_theme_options = { 'titles_only': False, } -html_static_path = ['source/_static'] +html_static_path = ['_static'] -html_theme_path = ['source/_templates'] +html_theme_path = ['_templates'] -html_css_files = ['source/_static/Jam.py.html_files/freemind2html.css'] +html_css_files = ['_static/Jam.py.html_files/freemind2html.css'] -html_favicon = 'source/_static/favicon.ico' +html_favicon = '_static/favicon.ico' html_last_updated_fmt = '%b %d, %Y' @@ -59,7 +62,38 @@ html_context = { 'googleanalytics_id': googleanalytics_id, } -# -- Python link_code_resolve configuration +htmlhelp_basename = 'Jampydocumentationdoc' + +# -- Options for LaTeX output --------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-latex-output + +latex_documents = [ + (master_doc, 'Jampydocumentation.tex', 'Jam.py Documentation', + 'Andrew Yushev & Dean D. Babic', 'manual'), +] + +# -- Options for manual page output --------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-man_pages + +man_pages = [ + (master_doc, 'jampydocumentation', u'Jam.py documentation Documentation', + [author], 1), +] + +# -- Options for Texinfo output ------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-texinfo_documents + +texinfo_documents = [ + (master_doc, 'Jampydocumentation', u'Jam.py documentation Documentation', + author, 'Jampydocumentation', 'One line description of project.', + 'Miscellaneous'), +] + +llms_txt_exclude = [ + "requirements", # Exclude the search page +] + +# -- Python link_code_resolve configuration ------------------------------- def linkcode_resolve(domain, info): """Map specific exceptions to specific files.""" @@ -73,4 +107,5 @@ def linkcode_resolve(domain, info): } exception_name = info['fullname'] + return mapping.get(exception_name) \ No newline at end of file diff --git a/source/contents.rst b/source/contents.rst new file mode 100644 index 0000000..9afcc7e --- /dev/null +++ b/source/contents.rst @@ -0,0 +1,20 @@ +============================= +Jam.py documentation contents +============================= + +.. toctree:: + :hidden: + + index + +.. toctree:: + :maxdepth: 3 + + intro/index + programming/index + faq/index + how_to/index + admin/index + refs/index + releases/index + jampy-design-doco/contents \ No newline at end of file