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

Add awesome-panel-cli docs #6

Open
MarcSkovMadsen opened this issue Oct 9, 2022 · 0 comments
Open

Add awesome-panel-cli docs #6

MarcSkovMadsen opened this issue Oct 9, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@MarcSkovMadsen
Copy link
Contributor

I would like to have docs available on read the docs to help users of this package.

Accept Criteria

  • [] Sphinx Docs
  • [] Furo theme
  • [] Basic docs files written
  • [] Docs deployed to read the docs
  • [] The relevant sphinx commands added to the awesome-panel-cli
  • [] docs folder added to project template
  • [] General concept for docs as commands in the awesome-panel-cli, for example pn docs build, pn docs rebuild, pn docs serve.
  • [] General concept for testing docs added as pn test docs or similar.
  • [] Automated testing of docs added to github actions.
@MarcSkovMadsen MarcSkovMadsen added documentation Improvements or additions to documentation good first issue Good for newcomers labels Oct 9, 2022
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 good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant