Styling and layout for docs

docs/_static/css/custom.css

@@ -0,0 +1,22 @@
+/*
+ * yaclog: yet another changelog tool
+ * Copyright (c) 2021. Andrew Cassidy
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+.rst-content .toctree-wrapper:not(:last-child) ul {
+   margin-bottom: 0;
+   /* make adjacent toctrees appear to merge */
+}

docs/_templates/layout.html

@@ -0,0 +1,10 @@
+{% extends "!layout.html" %}
+{% block extrahead %}
+    <link rel="icon" type="image/png" sizes="16x16" href="_static/icon-16.png">
+    <link rel="icon" type="image/png" sizes="32x32" href="_static/icon-32.png">
+    <link rel="icon" type="image/png" sizes="48x48" href="_static/icon-48.png">
+    <link rel="icon" type="image/png" sizes="64x64" href="_static/icon-64.png">
+    <link rel="icon" type="image/png" sizes="128x128" href="_static/icon-128.png">
+    <link rel="icon" type="image/png" sizes="256x256" href="_static/icon-256.png">
+    {{ super() }}
+{% endblock %}

docs/changelog.md

@@ -0,0 +1,2 @@
+```{include} ../CHANGELOG.md
+```

docs/conf.py

@@ -13,14 +13,15 @@
 # import os
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
-
+from pkg_resources import get_distribution
 
 # -- Project information -----------------------------------------------------
 
 project = 'Yaclog'
 copyright = '2021, Andrew Cassidy'
 author = 'Andrew Cassidy'
-
+release = get_distribution('yaclog').version
+version = '.'.join(release.split('.')[:3])
 
 # -- General configuration ---------------------------------------------------
 
@@ -28,6 +29,7 @@ author = 'Andrew Cassidy'
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
+    'myst_parser', 'sphinx_rtd_theme'
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -38,15 +40,17 @@ templates_path = ['_templates']
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
-
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = 'sphinx_rtd_theme'
+html_logo = 'docs_logo.png'
+html_favicon = 'favicon.ico'
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ['_static']
+html_css_files = ['css/custom.css']

docs/index.rst

@@ -8,8 +8,17 @@ Welcome to Yaclog's documentation!
 
 .. toctree::
    :maxdepth: 2
+   :includehidden:
    :caption: Contents:
 
+   Changelog <changelog>
+
+.. toctree::
+   :maxdepth: 1
+
+   Changelog <changelog>
+   License <license>
+
 
 
 Indices and tables

docs/license.md

@@ -0,0 +1,2 @@
+```{include} ../LICENSE.md
+```