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

Docs: Create starter sphinx docs for pyosMeta package #181

Open
lwasser opened this issue Jul 4, 2024 · 0 comments
Open

Docs: Create starter sphinx docs for pyosMeta package #181

lwasser opened this issue Jul 4, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed sprintable

Comments

@lwasser
Copy link
Member

lwasser commented Jul 4, 2024

I think it's time to create docs for this package. we should use the pydata_sphinx_theme given we've used this elsewhere.

This issue is to just create the start of initial sphinx documentation structure that we can publish online.

The structure of our docs should have

  • a developing / contributing section
  • an about section.
  • api docs

We can start with a blank set of docs and slowly build them out pulling content from our readme file and the development docs when created in #180

@lwasser lwasser added help wanted Extra attention is needed sprintable labels Jul 4, 2024
@lwasser lwasser added the documentation Improvements or additions to documentation label Jul 12, 2024
@lwasser lwasser changed the title Create docs for this package Docs: Create starter sphinx docs for pyosMeta package Jul 12, 2024
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 help wanted Extra attention is needed sprintable
Development

No branches or pull requests

1 participant