Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Stand-alone documentation #448

Merged
merged 1 commit into from Dec 1, 2022

Conversation

seifertm
Copy link
Contributor

This PR creates a stand-alone HTML documentation using Sphinx and ReStructuredText.

The structure roughly follows the Diátaxis documentation framework in that it divides the content into four categories. Pytest-asyncio doesn't have tutorials and how-to guides at the moment, so these categories are missing. The Explanation category was named Concepts. The documentation contains a supplementary section about how users can get support for pytest-asyncio.

Most contents of the stand-alone documentation were extracted from the README. However, the contents have been restructured and rephrased to fit into the new structure.

The docs can be built by entering the docs folder and running make html.

@asvetlov @Tinche I would like to add you to the corresponding readthedocs project. Please give me your account names on that site so I can give you access to the RTD-project.

Closes #408

Signed-off-by: Michael Seifert <m.seifert@digitalernachschub.de>
@codecov-commenter
Copy link

Codecov Report

Base: 92.41% // Head: 92.41% // No change to project coverage 👍

Coverage data is based on head (90bd462) compared to base (d39589c).
Patch has no changes to coverable lines.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #448   +/-   ##
=======================================
  Coverage   92.41%   92.41%           
=======================================
  Files           3        3           
  Lines         277      277           
  Branches       38       38           
=======================================
  Hits          256      256           
  Misses         13       13           
  Partials        8        8           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@seifertm seifertm merged commit 56a393a into pytest-dev:master Dec 1, 2022
@seifertm seifertm deleted the documentation-artefact branch October 23, 2023 06:16
@seifertm seifertm restored the documentation-artefact branch October 23, 2023 08:17
@seifertm seifertm deleted the documentation-artefact branch October 23, 2023 08:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Dedicated documentation artefact
2 participants