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

Setup of documentation/website #45

Closed
jdries opened this issue Mar 22, 2022 · 4 comments
Closed

Setup of documentation/website #45

jdries opened this issue Mar 22, 2022 · 4 comments

Comments

@jdries
Copy link
Contributor

jdries commented Mar 22, 2022

Provide basic structure within the repo for documenting the library (e.g. using markdown/Sphinx)
If possible, use github actions to publish as github pages.

Website can also use static generator mechanism, to be investigated.

@soxofaan
Copy link
Member

did a bit of research and Markdown can be used (alongside RST) in Sphinx.
MyST seems to be the [recommended "plugin" to do this nowadays

@soxofaan
Copy link
Member

I've set up

soxofaan added a commit that referenced this issue Apr 13, 2022
@soxofaan
Copy link
Member

Did initial setup of autodoc, but that's pretty empty at this point (no real source code in the package, e.g see #46 )

@soxofaan
Copy link
Member

I think we can close this issue for now, the main original points are covered

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants