Merge pull request #305 from dbatten5/furo-docs

Furo docs

.github/workflows/tests.yml

@@ -32,6 +32,7 @@ jobs:
           # - { python: "3.11", os: macos-latest, session: "tests" }
           - { python: "3.11", os: ubuntu-latest, session: "typeguard" }
           - { python: "3.11", os: ubuntu-latest, session: "xdoctest" }
+          - { python: "3.11", os: "ubuntu-latest", session: "docs-build" }
 
     env:
       NOXSESSION: ${{ matrix.session }}
@@ -107,6 +108,13 @@ jobs:
           name: coverage-data
           path: ".coverage.*"
 
+      - name: Upload documentation
+        if: matrix.session == 'docs-build'
+        uses: actions/upload-artifact@v3
+        with:
+          name: docs
+          path: docs/_build
+
   coverage:
     runs-on: ubuntu-latest
     needs: tests

.readthedocs.yml

@@ -0,0 +1,12 @@
+version: 2
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.10"
+sphinx:
+  configuration: docs/conf.py
+formats: all
+python:
+  install:
+    - requirements: docs/requirements.txt
+    - path: .

CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[[email protected]](mailto:[email protected]).
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][mozilla coc].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][faq]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[mozilla coc]: https://github.com/mozilla/diversity
+[faq]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

@@ -0,0 +1,115 @@
+# Contributor Guide
+
+Thank you for your interest in improving this project.
+This project is open-source under the [MIT license] and
+welcomes contributions in the form of bug reports, feature requests, and pull requests.
+
+Here is a list of important resources for contributors:
+
+- [Source Code]
+- [Documentation]
+- [Issue Tracker]
+- [Code of Conduct]
+
+[mit license]: https://opensource.org/licenses/MIT
+[source code]: https://github.com/dbatten5/maison
+[documentation]: https://maison.readthedocs.io/
+[issue tracker]: https://github.com/dbatten5/maison/issues
+
+## How to report a bug
+
+Report bugs on the [Issue Tracker].
+
+When filing an issue, make sure to answer these questions:
+
+- Which operating system and Python version are you using?
+- Which version of this project are you using?
+- What did you do?
+- What did you expect to see?
+- What did you see instead?
+
+The best way to get your bug fixed is to provide a test case,
+and/or steps to reproduce the issue.
+
+## How to request a feature
+
+Request features on the [Issue Tracker].
+
+## How to set up your development environment
+
+You need Python 3.8+ and the following tools:
+
+- [Poetry]
+- [Nox]
+- [nox-poetry]
+
+Install the package with development requirements:
+
+```console
+$ poetry install
+```
+
+You can now run an interactive Python session,
+or the command-line interface:
+
+```console
+$ poetry run python
+$ poetry run maison
+```
+
+[poetry]: https://python-poetry.org/
+[nox]: https://nox.thea.codes/
+[nox-poetry]: https://nox-poetry.readthedocs.io/
+
+## How to test the project
+
+Run the full test suite:
+
+```console
+$ nox
+```
+
+List the available Nox sessions:
+
+```console
+$ nox --list-sessions
+```
+
+You can also run a specific Nox session.
+For example, invoke the unit test suite like this:
+
+```console
+$ nox --session=tests
+```
+
+Unit tests are located in the _tests_ directory,
+and are written using the [pytest] testing framework.
+
+[pytest]: https://pytest.readthedocs.io/
+
+## How to submit changes
+
+Open a [pull request] to submit changes to this project.
+
+Your pull request needs to meet the following guidelines for acceptance:
+
+- The Nox test suite must pass without errors and warnings.
+- Include unit tests. This project maintains 100% code coverage.
+- If your changes add functionality, update the documentation accordingly.
+
+Feel free to submit early, though—we can always iterate on this.
+
+To run linting and code formatting checks before committing your change, you can install pre-commit as a Git hook by running the following command:
+
+```console
+$ nox --session=pre-commit -- install
+```
+
+It is recommended to open an issue before starting work on anything.
+This will allow a chance to talk it over with the owners and validate your approach.
+
+[pull request]: https://github.com/dbatten5/maison/pulls
+
+<!-- github-only -->
+
+[code of conduct]: CODE_OF_CONDUCT.md

README.md

@@ -57,8 +57,10 @@ if config.get_option("enable_useful_option"):
 
 ## Help
 
-See the [documentation](https://dbatten5.github.io/maison) for more details.
+See the [documentation](https://maison.readthedocs.io) for more details.
 
 ## Licence
 
 MIT
+
+<!-- github-only -->

docs/codeofconduct.md

@@ -0,0 +1,3 @@
+```{include} ../CODE_OF_CONDUCT.md
+
+```

docs/conf.py

@@ -0,0 +1,12 @@
+"""Sphinx configuration."""
+project = "Maison"
+author = "Dom Batten"
+copyright = "2021, Dom Batten"  # noqa: A001
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
+    "sphinx_click",
+    "myst_parser",
+]
+autodoc_typehints = "description"
+html_theme = "furo"

docs/contributing.md

@@ -1,78 +1,7 @@
-# Issues
-
-If you notice an issue with `maison` or would like to suggest a feature or just
-have a general question, please raise an
-[issue](https://github.com/dbatten5/maison/issues) on GitHub. If it's an issue
-that needs debugging please make sure to include the version of `maison` in the
-issue description. You can retrieve the version with the following:
-
-```bash
-pip freeze | grep maison
+```{include} ../CONTRIBUTING.md
+---
+end-before: <!-- github-only -->
+---
 ```
 
-# Pull Requests
-
-If you would like to contribute to the repo, you would be most welcome. If
-you're tackling an existing issue please comment on the issue that you'd like to
-take it on. If it's a new feature/bug, please first raise an issue. There is
-also a `kanban` board [here](https://github.com/dbatten5/maison/projects/1) for
-more feature ideas.
-
-# Local Development
-
-In order to work on your contribution, you'll need to first fork the repo and
-then clone it to your local machine:
-
-```bash
-git clone [email protected]:<your username>/maison.git
-cd maison
-```
-
-You'll need `python` 3.8+ to run this package. You can follow
-the instructions [here](https://cookiecutter-hypermodern-python.readthedocs.io/en/2021.6.15/guide.html#getting-python)
-to install and use these versions.
-
-This package uses `poetry` to manage dependencies. Ensure you have `poetry`
-installed, instructions [here](https://python-poetry.org/docs/#installation) and
-run:
-
-```bash
-poetry install
-```
-
-This will install the dependencies into a `.venv` virtual environment. You can
-activate the env with either `source .venv/bin/activate` or `poetry shell`.
-
-Next install the `pre-commit` hooks with:
-
-```bash
-pre-commit install
-```
-
-[Nox](https://nox.thea.codes/en/stable/) is used to run tests, linters, type
-checkers etc. These are all run in the CI and on `git commit` but if you'd like
-to run them manually, you can do so with, eg:
-
-```bash
-nox --session=tests
-```
-
-This will run the tests for all versions of python.
-
-See [here](https://cookiecutter-hypermodern-python.readthedocs.io/en/2021.6.15/guide.html#running-sessions)
-for more information on running `nox` locally.
-
-If you're making changes that will require updates to the documentation, please
-do so accordingly. Documentation lives in the `docs/` directory and can be
-served locally with:
-
-```bash
-mkdocs serve
-```
-
-See [here](https://squidfunk.github.io/mkdocs-material/getting-started/) for
-more information on working with `mkdocs`.
-
-Once you're ready with your shiny, TDD'd feature, commit, push, and open a pull
-request and I'll be happy to review. If you're having issues with any of this
-setup please do let me know and I'll try and help.
+[code of conduct]: codeofconduct