-
Notifications
You must be signed in to change notification settings - Fork 25
Add documentation boilerplate #28
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
Conversation
LGTM except for the failing tests. ;-) |
Codecov Report
@@ Coverage Diff @@
## main #28 +/- ##
=======================================
Coverage ? 97.02%
=======================================
Files ? 8
Lines ? 202
Branches ? 0
=======================================
Hits ? 196
Misses ? 6
Partials ? 0 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
@ntoll Should be good now. Mind a quick run through of the instructions I just added to |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall LGTM. I think we need to better describe the details of adding a plugin in the user guide but can be in a follow up PR. This one is great! TY! 🚀
|
||
|
||
Either of the above commands should launch a live dev server and you will be able to view the | ||
docs in your browser. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does it open then browser or the user needs to navigate to a specific URL?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great question! TIL, sphinx-autobuild
as an --open-browser
option. Now, there is a very easy way to start:
poetry run make -C docs live
Yes. This PR is definitely more about boilerplate and not content. But we should have a good skeleton to build upon now. |
Adds documentation boilerplate:
sphinx-apidoc
myst
parserpydata-sphinx-theme