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

migrate documentation #11

Closed
tkittel opened this issue Nov 3, 2023 · 4 comments
Closed

migrate documentation #11

tkittel opened this issue Nov 3, 2023 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation high priority

Comments

@tkittel
Copy link
Member

tkittel commented Nov 3, 2023

Old dgcode documentation should be split up as appropriate for simplebuild and simplebuild-dgcode, migrated to sphinx, and placed somewhere easy (github pages?).

@tkittel tkittel added the documentation Improvements or additions to documentation label Nov 3, 2023
@tkittel tkittel self-assigned this Jan 11, 2024
@tkittel
Copy link
Member Author

tkittel commented Jan 11, 2024

The sphinx+githubpages-based website is now at: https://mctools.github.io/simplebuild/

It is still not completely done.

@tkittel
Copy link
Member Author

tkittel commented Jan 11, 2024

When almost done we should enable nitpicky=True in conf.py, and we should make sure to also run make linkcheck in the CI tests.

@tkittel
Copy link
Member Author

tkittel commented Jan 16, 2024

Done apart from needing some read-throughs and the issues in the last comments.

@tkittel
Copy link
Member Author

tkittel commented Feb 21, 2024

Done!!

@tkittel tkittel closed this as completed Feb 21, 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 high priority
Projects
None yet
Development

No branches or pull requests

2 participants