spacecow99 / pyproject-package Goto Github PK

Move the default sphinx docs/ folder over from the default template to that supported by Read the Docs.

Add py310 to tox envlist.

Considering our primary document hosting sources (Github, Github Pages and ReadTheDocs) all support Markdown in some shape or form, it is worth migrating our default sphinx documents over to Markdown by default and using the MyST package.

• Rename files from *.rst to *.md
• Reformat index.rst in to markdown
• Add myst-parser as a docs dependency in pyproject.toml
• Configure myst-parser and exclude .venv in conf.py

Currently the Installation section within our generated README.md uses pip to install, we should be using flit.

Currently the [project].readme points to the old README.rst which breaks builds and installs. This needs to be updated to point to the new markdown file.

The skeleton README file in the cookiecutter should be converted to markdown once issue #3 is completed. This will ensure consistency across explicit documentation (outside of docstrings) and allow it to be easily referenced in sphinx docs using myst-parser.

Test example has no connection with any code. Improvement suggestion: add something as simple as a trivial function like

def sum(a, b):
    return a + b

to the package. Add a test that uses said code to tests/test_sample.py

A verbose README.rst document, like that of cookiecutter-pypackage-minimal, should be created before repository goes public.

Add support for a default python3 devcontainer.json for VSCode, potentially with additional scripts.