Add API documentation

3 years ago · 36ab0930fe
parent f085f318b3
commit 36ab0930fe
3 changed files with 10 additions and 11 deletions
--- a/docs/index.rst
+++ b/docs/index.rst
@ -1,14 +1,12 @@
-.. Yaclog documentation master file, created by
-   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.
+Yaclog: Yet Another Command Line Changelog Tool
+===============================================

-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::
   :maxdepth: 2
-   :includehidden:
   :caption: Contents:

   API Reference <reference/index.rst>
--- a/docs/reference/index.rst
+++ b/docs/reference/index.rst
@ -2,7 +2,8 @@ API Reference
 =============

 .. toctree::
-   :maxdepth: 1
-   :glob:
+   :maxdepth: 2

-   *
+   changelog.rst
+   markdown.rst
+   version.rst
--- a/docs/reference/markdown.rst
+++ b/docs/reference/markdown.rst
@ -1,5 +1,5 @@
 Markdown Module
-==============
+===============

 .. automodule:: yaclog.markdown
    :members: