Conversation
Everything in these directories are created by sphinx so we do not need to track them.
The docstrings should be enough to remove the need to manually write anything related to the API and low level code. We will still however write some additional content as time goes on.
This is lifted from their front page with an alteration to use the docs dependency rather than a requirements.txt file.
Might need to tweak the `on` section as we only really want to update the site on a new release. Although we do want to ensure the various files haven't been broken.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #33 +/- ##
=======================================
Coverage 99.55% 99.55%
=======================================
Files 15 15
Lines 448 448
=======================================
Hits 446 446
Misses 2 2 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
I want to include the README as-is in the docs website. As a result a relative path to another file in the repo no longer makes sense so we need to use the absolute path.
Owner
Author
|
The website looks as expected locally and all the pipelines are passing, but I can't see the project when trying to add it on my read the docs account page. This may be because the initial setup has to be with the The pages, and general usability, are very rough as it currently is, but I'm going to merge this PR anyway to try and get the site live. I'll create another PR to polish the content. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Start working on #32