drewcassidy/yaclog
1
0
Fork 0
mirror of https://github.com/drewcassidy/yaclog.git synced 2024-09-01 14:58:58 +00:00
Code Issues Projects Releases Wiki Activity

Add API documentation

Browse Source
This commit is contained in:
Andrew Cassidy 2021-05-04 21:16:02 -07:00
parent f085f318b3
commit 36ab0930fe
3 changed files with 10 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/index.rst
View File

@ -1,14 +1,12 @@
.. Yaclog documentation master file, created by Yaclog: Yet Another Command Line Changelog Tool
sphinx-quickstart on Tue May 4 13:30:49 2021. ===============================================
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Yaclog's documentation! Yaclog is a python library and command line tool to make it easier to keep track of changes to your projects.
================================== It includes commands for appending new changes to a markdown changelog file, as well as releasing new versions
for deployment via git tags.
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
:includehidden:
:caption: Contents: :caption: Contents:
API Reference <reference/index.rst> API Reference <reference/index.rst>

7
docs/reference/index.rst
View File

@ -2,7 +2,8 @@ API Reference
============= =============
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 2
:glob:
* changelog.rst
markdown.rst
version.rst

2
docs/reference/markdown.rst
View File

@ -1,5 +1,5 @@
Markdown Module Markdown Module
============== ===============
.. automodule:: yaclog.markdown .. automodule:: yaclog.markdown
:members: :members: