Pi _ Sphinx
dwisianto edited this page Feb 11, 2023
·
11 revisions
# 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': '',
}
.. 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`
- https://jugmac00.github.io/til/how-to-add-a-menu-to-the-sidebar-with-sphinx/
- https://stackoverflow.com/questions/16123951/how-do-i-include-the-homepage-in-the-sphinx-toc
- https://sphinx-test-reports.readthedocs.io/en/latest/#introduction
- https://github.com/thisch/pytest-sphinx
- https://www.sphinx-doc.org/en/master/usage/extensions/doctest.html
- https://sphinx-test-reports.readthedocs.io/en/latest/
- https://sphinx-needs.readthedocs.io/en/latest/
- https://readthedocs.org/projects/sphinx-test-reports/downloads/pdf/latest
OS - win - mac - bash - make - Git - Git GitHub - VSCode - vscode - settings - Docker - docker - dk-compose
Ubuntu - tigervnc
- https://gist.github.com/indyfromoz/739cd53d47b91ba1d3b540ab53b1f46c
- https://haydenjames.io/remove-snap-ubuntu-22-04-lts/
AirFlow - airflow_install_anaconda
Geo - geo_course_gds16 - geo_course_gds G_tools pysal G_data geo_data G_format geo_format_shapefile g_db geo_db_spatialite geo_dash geo_plotly_dash
Semantic - s1 - s2 - RDF - OWL - SKOS - FOAF - Protoge - rdflib - owlready - swrl1 - sql1
Graph - g1
TinkerPopOverview = GremlinTraversalLanguage - TinkerGraph - GremlinConsole - GremlinLanguageVariant - GremlinServer - Documentation TinkerPopInstallation =