Skip to content

Stand-alone documentation#448

Merged
seifertm merged 1 commit intopytest-dev:masterfrom
seifertm:documentation-artefact
Dec 1, 2022
Merged

Stand-alone documentation#448
seifertm merged 1 commit intopytest-dev:masterfrom
seifertm:documentation-artefact

Conversation

@seifertm
Copy link
Copy Markdown
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>
@seifertm seifertm force-pushed the documentation-artefact branch from 3e87c2a to 90bd462 Compare November 21, 2022 06:19
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Nov 21, 2022

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.41%. Comparing base (d39589c) to head (90bd462).

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           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@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