added some additional documentation
This commit is contained in:
parent
e6f70d150c
commit
2c18e37cbe
4
docs/dev_doc.md
Normal file
4
docs/dev_doc.md
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
# Developer documentation
|
||||||
|
|
||||||
|
This documentation is mainly for developers who wish to create a third party
|
||||||
|
module
|
@ -3,11 +3,11 @@
|
|||||||
You can adapt this file completely to your liking, but it should at least
|
You can adapt this file completely to your liking, but it should at least
|
||||||
contain the root `toctree` directive.
|
contain the root `toctree` directive.
|
||||||
|
|
||||||
|
Inkycal documentation
|
||||||
|
======================
|
||||||
.. image:: ../Gallery/logo.png
|
.. image:: ../Gallery/logo.png
|
||||||
:align: center
|
:align: center
|
||||||
|
|
||||||
Inkycal documentation
|
|
||||||
======================
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
:caption: Contents:
|
:caption: Contents:
|
||||||
@ -15,6 +15,7 @@ Inkycal documentation
|
|||||||
inkycal
|
inkycal
|
||||||
about
|
about
|
||||||
quickstart
|
quickstart
|
||||||
|
dev_doc
|
||||||
|
|
||||||
Indices and tables
|
Indices and tables
|
||||||
==================
|
==================
|
||||||
|
@ -16,3 +16,10 @@ Custom functions
|
|||||||
.. automodule:: inkycal.custom.functions
|
.. automodule:: inkycal.custom.functions
|
||||||
:members:
|
:members:
|
||||||
|
|
||||||
|
Helper classes
|
||||||
|
=================
|
||||||
|
.. automodule:: inkycal.modules.ical_parser
|
||||||
|
:members:
|
||||||
|
|
||||||
|
.. automodule:: inkycal.modules.inky_image
|
||||||
|
:members:
|
||||||
|
Loading…
Reference in New Issue
Block a user