Skip to content

Dedicated documentation artefact #408

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

Closed
seifertm opened this issue Sep 16, 2022 · 0 comments · Fixed by #448
Closed

Dedicated documentation artefact #408

seifertm opened this issue Sep 16, 2022 · 0 comments · Fixed by #448

Comments

@seifertm
Copy link
Contributor

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 may help.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant