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

Fix/docs #268

Merged
merged 4 commits into from
Mar 12, 2022
Merged

Fix/docs #268

merged 4 commits into from
Mar 12, 2022

Conversation

wpfff
Copy link
Contributor

@wpfff wpfff commented Mar 12, 2022

the doc structure took a few odd turns and was quite neglected. we're starting this fresh.

@wpfff wpfff merged commit b7abe3c into toolsforexperiments:master Mar 12, 2022
@wpfff wpfff deleted the fix/docs branch March 12, 2022 22:45
@jenshnielsen
Copy link
Collaborator

@wpfff What do you think about letting github actions build the docs in ci so this does not happen again?

@wpfff
Copy link
Contributor Author

wpfff commented Mar 13, 2022

hm, so currently I'm only aware of a web hook to build docs on RTD automatically, that's not an issue.
The thing here is more that the docs weren't very good :)
I currently have one of my students (@marcosfrenkel) work on this.

because we have some other tools that build on qcodes we were now thinking of setting up the following:
docs within the package are 'only' good docstrings, essentially.
The 'manual' we would like to do such that it captures multiple packages that we maintain and will live under a separate repo (https://github.com/toolsforexperiments/tfe-manual) that links to toolsforexperiments.rtfd.org.

Do you have any thoughts?

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.

2 participants