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

📝 Initialize Documentation on ReadTheDocs #74

Merged
merged 4 commits into from
Sep 7, 2022
Merged

Conversation

burgholzer
Copy link
Member

This PR adds the initial configuration and infrastructure for building proper project documentation on ReadTheDocs.

Building the documentation locally is as easy as

nox -rs docs -- serve

nox is best installed via pipx install nox (or brew install nox if you are on macOS). If you don't have pipx (pip for applications) you can install it with pip install pipx (or brew install pipx if you are on macOS).

At the moment the documentation is pretty much empty. Filling it with content will be done in a separate PR.

Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
@burgholzer burgholzer added the documentation Improvements or additions to documentation label Sep 7, 2022
@burgholzer burgholzer self-assigned this Sep 7, 2022
@codecov
Copy link

codecov bot commented Sep 7, 2022

Codecov Report

Merging #74 (e00547e) into main (2821def) will not change coverage.
The diff coverage is n/a.

@@          Coverage Diff          @@
##            main     #74   +/-   ##
=====================================
  Coverage   91.2%   91.2%           
=====================================
  Files         29      29           
  Lines       1825    1825           
=====================================
  Hits        1666    1666           
  Misses       159     159           

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

@burgholzer burgholzer merged commit ae0d1e6 into main Sep 7, 2022
@burgholzer burgholzer deleted the documentation branch September 7, 2022 13:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant