EnvGap
Dedicated documentation artefact
envgap__pytest-dev__pytest-asyncio-408
01 / FAILURE SIGNATURE
As reported upstream
No identifying execution failure has been captured.
Not a benchmark task.
- The project already builds and runs before the fix, so there is nothing to repair.
02 / ENVIRONMENT RECIPE
- Base commit
0b281b1b76b93c29894519e0750a4f8634786741- Manifest
setup.cfg- Reproduce
Awaiting issue-specific recipe- Run under trace
Awaiting a meaningful runtime command
03 / ORIGINAL ISSUE TEXT
pytest-dev/pytest-asyncio #408 · read the original issue
Pytest-asyncio's documentation currently lives it's README. Since the README should only contain the most relevant information about a project the current setup requires a balance between adding more documentation and having a bloated README. The idea of this issue is to create a build process for a separate documentation artefact. The documentation should be built using Sphinx and the result should be a static HTML website. All required build files should reside in the `docs` directory. For the purpose of this issue the build can be performed manually without integration into the CI pipeline. As a starting point the documentation artefact may contain the same structure and contents as the README. The [Sphinx tutorial](https://www.sphinx-doc.org/en/master/tutorial/index.html) may help.
04 / LABELS
Labels from the report text only; not yet run
No supported category has been assigned.
Label rules and the text that matched
[]