Skip to content

Conversation

mattkram
Copy link
Collaborator

Adds documentation boilerplate:

@ntoll
Copy link
Member

ntoll commented Aug 24, 2022

LGTM except for the failing tests. ;-)

@codecov-commenter
Copy link

Codecov Report

❗ No coverage uploaded for pull request base (main@2cdfd57). Click here to learn what that means.
The diff coverage is n/a.

@@           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.

@mattkram
Copy link
Collaborator Author

mattkram commented Aug 24, 2022

LGTM except for the failing tests. ;-)

@ntoll Should be good now. Mind a quick run through of the instructions I just added to CONTRIBUTING.md?

@mattkram mattkram marked this pull request as ready for review August 24, 2022 15:05
Copy link
Contributor

@fpliger fpliger left a 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.
Copy link
Contributor

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?

Copy link
Collaborator Author

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

@mattkram
Copy link
Collaborator Author

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! 🚀

Yes. This PR is definitely more about boilerplate and not content. But we should have a good skeleton to build upon now.

@fpliger
Copy link
Contributor

fpliger commented Aug 24, 2022

:)

@mattkram mattkram merged commit 947ee97 into main Aug 24, 2022
@mattkram mattkram deleted the mattkram/docs-boilerplate branch August 24, 2022 16:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants