From 1b1932fbb4b420ac5fb9bb0db5f6fefcb0331dc3 Mon Sep 17 00:00:00 2001 From: Reilly Tucker Siemens Date: Wed, 9 Dec 2020 01:29:41 -0800 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Update=20docs=20to=20use=20Furo?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONTRIBUTING.rst | 34 ++++++++++++++++++---------------- docs/conf.py | 34 ++++------------------------------ docs/index.rst | 11 +++++------ pyproject.toml | 3 ++- 4 files changed, 29 insertions(+), 53 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 8726f98..09ea765 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -46,18 +46,16 @@ Handling Pull Requests - A maintainer will respond to Pull Requests with one of: - - 'Ship It', 'LGTM', 🚢, or some other affirmation + - ``Ship It``, ``LGTM``, 🚢, or some other affirmation - What must be changed - Won't accept and why -Nota Bene -+++++++++ - -- Submitting a `draft pull request`_ is a good way to get feedback from - maintainers if you are unsure of the changes you are making. -- A pull request that has been approved may not be merged immediately. -- You may be asked to rebase or squash your commits to keep an orderly version - control history. +.. note:: + - Submitting a `draft pull request`_ is a good way to get feedback from + maintainers if you are unsure about your changes. + - A pull request that has been approved may not be merged immediately. + - You may be asked to rebase or squash your commits to keep an orderly version + control history. .. _version control: @@ -97,14 +95,18 @@ repository's `tox`_ configuration. To validate your coding style run Test Environment ~~~~~~~~~~~~~~~~ -- Code **must** be tested. Write or update related unit tests so you don't have - to manually retest the same thing many times. +- Code **must** be tested. Write or update related unit tests to avoid repeated + manual testing. - Tests for this project are written using the `pytest`_ framework and executed - via `tox`_. While it isn't always achievable this project strives to maintain - 💯% test coverage. -- In addition to unit testing code in this project is statically type checked - using `mypy`_, formatted with `black`_, linted using `flake8`_, and security - checked with `bandit`_. + via `tox`_. +- While it isn't always achievable this project strives to maintain 💯% test + coverage. +- In addition to unit testing code in this project is + + - statically type checked using `mypy`_ + - formatted with `black`_ + - linted using `flake8`_ + - and security checked with `bandit`_ Here are some example invocations for running unit tests/static analysis. diff --git a/docs/conf.py b/docs/conf.py index ddd8ed7..ccd7f8d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,19 +1,10 @@ # Configuration file for the Sphinx documentation builder. # -# This file only contains a selection of the most common options. For a full -# list see the documentation: +# Full list of options can be found in the Sphinx documentation: # https://www.sphinx-doc.org/en/master/usage/configuration.html # -- Path setup -------------------------------------------------------------- -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -# -# import os -# import sys -# sys.path.insert(0, os.path.abspath('.')) - import datetime as dt from pathlib import Path import sys @@ -27,20 +18,16 @@ changelog_mtime = Path("../CHANGELOG.rst").stat().st_mtime copyright_year = dt.datetime.utcfromtimestamp(changelog_mtime) -homepage = "https://tuckersiemens.com" project = "ipython-style-gruvbox" author = __author__ release = __version__ version = ".".join(release.split(".", 2)[:2]) -copyright = f'{copyright_year:%Y}, {author}' +copyright = f'{copyright_year:%Y}, {author}' # -- General configuration --------------------------------------------------- -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. extensions = [ "sphinx.ext.autodoc", "sphinx.ext.todo", @@ -50,23 +37,10 @@ "sphinx_autodoc_typehints", ] -# Add any paths that contain templates here, relative to this directory. -templates_path = ["_templates"] - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# 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" - -# 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_theme = "furo" +html_title = "IPython Style Gruvbox" diff --git a/docs/index.rst b/docs/index.rst index 9f42345..2e5a584 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -77,14 +77,13 @@ or add it to your `IPython config`_. config = get_config() config.TerminalInteractiveShell.highlighting_style = "gruvbox" -*Note:* This will only affect your syntax highlighting. If you're looking to -create a prompt that looks exactly like the one in the image above this -`example prompt`_ might help. - -Project Info ------------- +.. note:: + This will only affect your syntax highlighting. If you're looking to + create a prompt that looks exactly like the one in the image above this + `example prompt`_ might help. .. toctree:: + :hidden: :maxdepth: 1 Code of Conduct diff --git a/pyproject.toml b/pyproject.toml index 2309dc4..c04d324 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -96,8 +96,9 @@ commands = [testenv:docs] basepython = python3.9 deps = - sphinx ~= 2.3.0 + sphinx ~= 3.3.0 sphinx-autodoc-typehints ~= 1.10.0 + furo == 2020.11.27b19 commands_pre = commands = sphinx-build -b html docs {posargs:docs/_build/html}