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.

Sign up for GitHub

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

Jump to bottom

Documentation #98

Open
mbruns91 opened this issue Oct 18, 2023 · 1 comment
Open

Documentation #98

mbruns91 opened this issue Oct 18, 2023 · 1 comment

Comments

@mbruns91
Copy link

mbruns91 commented Oct 18, 2023 •
edited
Loading

While setting up the CI, I also created the doc/ dir, with empty files conf.py and index.rst. I did not know right away, what to do further with them. Do we have some documentation of structuretoolkit anywhere?
@jan-janssen
Copy link
Member

I guess currently the majority of the documentation is in the docstrings, but adding a more extensive documentation is definitely on the list.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@jan-janssen @mbruns91