Add Sphinx documentation files

This commit is contained in:
2024-01-26 14:53:23 -05:00
parent 21dd3740eb
commit 8f4a7b7bb5
7 changed files with 154 additions and 6 deletions
+28
View File
@@ -0,0 +1,28 @@
# 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 = 'neon-client'
copyright = '2024, Kenneth Reitz'
author = 'Kenneth Reitz'
release = '0.1.0'
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions = []
templates_path = ['_templates']
exclude_patterns = []
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
html_theme = 'alabaster'
html_static_path = ['_static']
+20
View File
@@ -0,0 +1,20 @@
.. neon-client documentation master file, created by
sphinx-quickstart on Thu Jan 25 14:50:47 2024.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to neon-client's documentation!
=======================================
.. toctree::
:maxdepth: 2
:caption: Contents:
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`