From 36ab0930fe0676a35ac24662aa6ea2da7b56f3e2 Mon Sep 17 00:00:00 2001 From: drewcassidy Date: Tue, 4 May 2021 21:16:02 -0700 Subject: [PATCH] Add API documentation --- docs/index.rst | 12 +++++------- docs/reference/index.rst | 7 ++++--- docs/reference/markdown.rst | 2 +- 3 files changed, 10 insertions(+), 11 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index edc6a6a..36949c0 100644 --- 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 diff --git a/docs/reference/index.rst b/docs/reference/index.rst index c74a015..5519e20 100644 --- a/docs/reference/index.rst +++ b/docs/reference/index.rst @@ -2,7 +2,8 @@ API Reference ============= .. toctree:: - :maxdepth: 1 - :glob: + :maxdepth: 2 - * \ No newline at end of file + changelog.rst + markdown.rst + version.rst \ No newline at end of file diff --git a/docs/reference/markdown.rst b/docs/reference/markdown.rst index c8b48d2..f04e1a8 100644 --- a/docs/reference/markdown.rst +++ b/docs/reference/markdown.rst @@ -1,5 +1,5 @@ Markdown Module -============== +=============== .. automodule:: yaclog.markdown :members: \ No newline at end of file