Pi _ Sphinx - dwisianto/dwisianto GitHub Wiki

QuickStart

Basic

makefile

conf.py

# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = 'Hello'
copyright = '2023, Hello'
author = 'dwisianto'

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

extensions = []

templates_path = ['_templates']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']



# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output


html_theme = 'sphinx_material'
html_static_path = ['_static']
#html_sidebars = {
#    '**': [
#        'searchbox.html', 'globaltoc.html'
#    ]
#}

html_sidebars = {
    "**": ["logo-text.html", "globaltoc.html", "localtoc.html", "searchbox.html"]
}


# Required theme setup
html_theme = 'sphinx_material'

# Set link name generated in the top bar.
html_title = 'Project Description'

# Material theme options (see theme.conf for more information)
html_theme_options = {

    # Set the name of the project to appear in the navigation.
    'nav_title': 'Mine',

    # Set the color and the accent color
    # brown, red
    'color_primary': 'indigo',
    'color_accent': 'deep-blue',

    # Set you GA account ID to enable tracking
    #'google_analytics_account': 'UA-XXXXX',

    # Specify a base_url used to generate sitemap.xml. If not
    # specified, then no sitemap will be built.
    #'base_url': 'https://project.github.io/project',

    # Set the repo location to get a badge with stats
    #'repo_url': 'https://github.com/project/project/',
    #'repo_name': 'Project',

    # Visible levels of the global TOC; -1 means unlimited
    'globaltoc_depth': 3,
    # If False, expand all TOC entries
    'globaltoc_collapse': False,
    # If True, show hidden TOC entries
    'globaltoc_includehidden': True,

    'logo_icon': '',
}

index

.. a documentation master file

Welcome
=======

Introduction goes here

.. toctree::
   :maxdepth: 1
   :hidden:

   Home<self>
   pages/sec01/sec.rst
   pages/sec02/sec02.rst


Indices
=======

* :ref:`genindex`
* :ref:`modindex`

Autogen

tox

pytest

Themes

⚠️ **GitHub.com Fallback** ⚠️