iicd/Inkycal
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

added some additional documentation

Browse Source
This commit is contained in:
Ace 2020-12-05 00:29:56 +01:00
parent e6f70d150c
commit 2c18e37cbe
3 changed files with 14 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/dev_doc.md Normal file
View File

@ -0,0 +1,4 @@
# Developer documentation
This documentation is mainly for developers who wish to create a third party
module

5
docs/index.rst
View File

@ -3,11 +3,11 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Inkycal documentation
======================
.. image:: ../Gallery/logo.png
:align: center
Inkycal documentation
======================
.. toctree::
:maxdepth: 2
:caption: Contents:
@ -15,6 +15,7 @@ Inkycal documentation
inkycal
about
quickstart
dev_doc
Indices and tables
==================

7
docs/inkycal.rst
View File

@ -16,3 +16,10 @@ Custom functions
.. automodule:: inkycal.custom.functions
:members:
Helper classes
=================
.. automodule:: inkycal.modules.ical_parser
:members:
.. automodule:: inkycal.modules.inky_image
:members: