arcanis/ahriman
1
0
Fork 0
mirror of https://github.com/arcan1s/ahriman.git synced 2025-07-23 10:49:55 +00:00
Code Issues Projects Releases Wiki Activity

Docstring update (#58)

Browse Source 
* migrate docstrings from reST to google format

* add raises note

Also change behaviour of the `from_option` method to fallback to
disabled instead of raising exception on unknown option

* fix part of warnings for sphinx

* make identation a bit more readable

* review fixes

* add verbose description for properties to make them parsed by sphinx extenstion

* add demo sphinx generator
This commit is contained in:
Evgenii Alekseev
2022-04-17 20:25:28 +03:00
committed by GitHub
parent 06bd29b78d
commit 4daff81d5f
203 changed files with 5246 additions and 1636 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/source/index.rst Normal file
View File

@ -0,0 +1,20 @@
.. ahriman documentation master file, created by
sphinx-quickstart on Sun Apr 17 18:05:36 2022.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to ahriman's documentation!
===================================
.. toctree::
:maxdepth: 2
:caption: Contents:
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`