docs: Split into multiple pages

This mostly reverts commit 4c8deae. We now have enough documentation to warrant separate pages and the RTD theme works better with them. We keep the "Usage" and "Release Notes" sections so any anchors pointing here are not broken (though the same cannot be said of any links to subcommands). The copyright year is updated. Signed-off-by: Stephen Finucane <[email protected]>
getpatchwork · Aug 29, 2018 · e7b422e · e7b422e
1 parent 0c1ef48
commit e7b422e
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 6 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -31,11 +31,11 @@
 source_suffix = '.rst'
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = 'contents'
 
 # General information about the project.
 project = u'git-pw'
-copyright = u'2017, Stephen Finucane'
+copyright = u'2018, Stephen Finucane'
 author = u'Stephen Finucane'
 
 # The version info for the project you're documenting, acts as replacement for

diff --git a/docs/contents.rst b/docs/contents.rst
@@ -0,0 +1,8 @@
+Contents
+========
+
+.. toctree::
+
+   index
+   usage
+   release-notes
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,18 +1,23 @@
 git-pw (Patchwork subcommand for Git)
 =====================================
 
+Overview
+--------
+
 .. include:: ../README.rst
    :start-line: 19
+   :end-line: 33
+
+.. include:: ../README.rst
+   :start-line: 34
    :end-line: -7
 
 Usage
 -----
 
-.. click:: git_pw.shell:cli
-   :prog: git-pw
-   :show-nested:
+See :doc:`usage`.
 
 Release Notes
 -------------
 
-.. release-notes::
+See :doc:`release-notes`.
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
@@ -0,0 +1,4 @@
+Release Notes
+=============
+
+.. release-notes::
diff --git a/docs/usage.rst b/docs/usage.rst
@@ -0,0 +1,6 @@
+Usage
+=====
+
+.. click:: git_pw.shell:cli
+   :prog: git-pw
+   :show-nested: