diff --git a/docs/_static/css/custom.css b/docs/_static/css/custom.css new file mode 100644 index 0000000..a51b44a --- /dev/null +++ b/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 . + */ + +.rst-content .toctree-wrapper:not(:last-child) ul { + margin-bottom: 0; + /* make adjacent toctrees appear to merge */ +} \ No newline at end of file diff --git a/docs/_static/icon-128.png b/docs/_static/icon-128.png new file mode 100644 index 0000000..7ff5a46 Binary files /dev/null and b/docs/_static/icon-128.png differ diff --git a/docs/_static/icon-16.png b/docs/_static/icon-16.png new file mode 100644 index 0000000..0ea1839 Binary files /dev/null and b/docs/_static/icon-16.png differ diff --git a/docs/_static/icon-256.png b/docs/_static/icon-256.png new file mode 100644 index 0000000..8f36a87 Binary files /dev/null and b/docs/_static/icon-256.png differ diff --git a/docs/_static/icon-32.png b/docs/_static/icon-32.png new file mode 100644 index 0000000..8564d61 Binary files /dev/null and b/docs/_static/icon-32.png differ diff --git a/docs/_static/icon-48.png b/docs/_static/icon-48.png new file mode 100644 index 0000000..4e0aa36 Binary files /dev/null and b/docs/_static/icon-48.png differ diff --git a/docs/_static/icon-64.png b/docs/_static/icon-64.png new file mode 100644 index 0000000..7815b56 Binary files /dev/null and b/docs/_static/icon-64.png differ diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html new file mode 100644 index 0000000..b9c6754 --- /dev/null +++ b/docs/_templates/layout.html @@ -0,0 +1,10 @@ +{% extends "!layout.html" %} +{% block extrahead %} + + + + + + + {{ super() }} +{% endblock %} \ No newline at end of file diff --git a/docs/changelog.md b/docs/changelog.md new file mode 100644 index 0000000..8261b35 --- /dev/null +++ b/docs/changelog.md @@ -0,0 +1,2 @@ +```{include} ../CHANGELOG.md +``` \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index 3c0988d..086680a 100644 --- a/docs/conf.py +++ b/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'] \ No newline at end of file +html_static_path = ['_static'] +html_css_files = ['css/custom.css'] diff --git a/docs/docs_logo.png b/docs/docs_logo.png new file mode 100644 index 0000000..3a1fadd Binary files /dev/null and b/docs/docs_logo.png differ diff --git a/docs/favicon.ico b/docs/favicon.ico new file mode 100644 index 0000000..9c3ce7c Binary files /dev/null and b/docs/favicon.ico differ diff --git a/docs/index.rst b/docs/index.rst index e34ca9c..609940d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -8,8 +8,17 @@ Welcome to Yaclog's documentation! .. toctree:: :maxdepth: 2 + :includehidden: :caption: Contents: + Changelog + +.. toctree:: + :maxdepth: 1 + + Changelog + License + Indices and tables diff --git a/docs/license.md b/docs/license.md new file mode 100644 index 0000000..6d90b6a --- /dev/null +++ b/docs/license.md @@ -0,0 +1,2 @@ +```{include} ../LICENSE.md +``` \ No newline at end of file