pytest-dev / pytest-dev/pytest-localserver

Add Sphinx-generated documentation

Open
#68 0 comments 0 reactions 1 assignee View on GitHub

@diazona is already working on this.

Since Aug 5, 2024.

documentation
Dominant language
Python
Stars
37
Forks
12
Avg merge
12h 27m
Merged PRs (30d)
1

Description

I would like to have HTML documentation generated by Sphinx for the stable release. While the README is doing perfectly fine at explaining how to use the package (and thus this isn't necessary), generating docs with Sphinx looks nicer and gives us more flexibility to expand the docs later.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.