docs : Add sphinx for handling documentation
Edit gitignore by ignoring the docs/build directory Add sphinx dependencies to pyproject Add docs folder
This commit is contained in:
36
docs/source/conf.py
Normal file
36
docs/source/conf.py
Normal file
@@ -0,0 +1,36 @@
|
||||
# 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 = 'unisync'
|
||||
copyright = '2026, Paul Retourné'
|
||||
author = 'Paul Retourné'
|
||||
release = '0.1.0'
|
||||
|
||||
# -- General configuration ---------------------------------------------------
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
||||
|
||||
extensions = [
|
||||
'sphinx.ext.autodoc',
|
||||
'sphinx.ext.viewcode',
|
||||
'sphinx.ext.napoleon',
|
||||
'sphinx.ext.todo'
|
||||
]
|
||||
|
||||
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_theme = 'sphinx_rtd_theme'
|
||||
html_static_path = ['_static']
|
||||
|
||||
autodoc_docstring_signature = True
|
||||
18
docs/source/index.rst
Normal file
18
docs/source/index.rst
Normal file
@@ -0,0 +1,18 @@
|
||||
.. unisync documentation master file, created by
|
||||
sphinx-quickstart on Sun Jan 4 15:02:58 2026.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
Documentation for unisync
|
||||
=========================
|
||||
|
||||
Unisync is a data synchronising tool built around `unison`_
|
||||
|
||||
.. _unison: https://github.com/bcpierce00/unison
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: Contents:
|
||||
|
||||
modules
|
||||
|
||||
7
docs/source/modules.rst
Normal file
7
docs/source/modules.rst
Normal file
@@ -0,0 +1,7 @@
|
||||
unisync
|
||||
=======
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
unisync
|
||||
77
docs/source/unisync.rst
Normal file
77
docs/source/unisync.rst
Normal file
@@ -0,0 +1,77 @@
|
||||
unisync package
|
||||
===============
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
unisync.argparser module
|
||||
------------------------
|
||||
|
||||
.. automodule:: unisync.argparser
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
|
||||
unisync.config module
|
||||
---------------------
|
||||
|
||||
.. automodule:: unisync.config
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
|
||||
unisync.defaults module
|
||||
-----------------------
|
||||
|
||||
.. automodule:: unisync.defaults
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
|
||||
unisync.errors module
|
||||
---------------------
|
||||
|
||||
.. automodule:: unisync.errors
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
|
||||
unisync.main module
|
||||
-------------------
|
||||
|
||||
.. automodule:: unisync.main
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
|
||||
unisync.paths module
|
||||
--------------------
|
||||
|
||||
.. automodule:: unisync.paths
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
|
||||
unisync.runners module
|
||||
----------------------
|
||||
|
||||
.. automodule:: unisync.runners
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
|
||||
unisync.synchroniser module
|
||||
---------------------------
|
||||
|
||||
.. automodule:: unisync.synchroniser
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
.. automodule:: unisync
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
Reference in New Issue
Block a user