-
Notifications
You must be signed in to change notification settings - Fork 57
Sphinx documentation update #1719
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
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks very nice!
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html | ||
python: | ||
install: | ||
- requirements: doc/requirements.txt |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- requirements: doc/requirements.txt | |
- requirements: doc/requirements.txt | |
doc/source/conf.in
Outdated
@@ -28,6 +30,7 @@ html_static_path = ['_static'] | |||
html_logo = '../../t8code_logo.png' | |||
|
|||
# Breathe Configuration | |||
breathe_projects = {"T8code": "@top_builddir@/doc/xml"} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
breathe_projects = {"T8code": "@top_builddir@/doc/xml"} | |
breathe_projects = {"t8code": "@top_builddir@/doc/xml"} |
doc/source/conf.py
Outdated
file.write(filedata) | ||
|
||
try: | ||
retcode = subprocess.call("cd ../; mkdir build; cd build; cmake .. -DT8CODE_BUILD_DOCUMENTATION=ON -DT8CODE_BUILD_DOCUMENTATION_SPHINX=ON && make -j V=0", shell=True) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would this call also build the documentation for all VTK/OCC specific functions?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a draft and currently aims to start with a minimal working example.
doc/source/conf.py
Outdated
html_logo = '../../t8code_logo.png' | ||
|
||
# Breathe Configuration | ||
breathe_default_project = "T8code" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
breathe_default_project = "T8code" | |
breathe_default_project = "t8code" |
Closes #1447
Use readthedocs / sphinx to build our documentatio using sphinx and host it via readthedocs.
All these boxes must be checked by the AUTHOR before requesting review:
Documentation:
,Bugfix:
,Feature:
,Improvement:
orOther:
.All these boxes must be checked by the REVIEWERS before merging the pull request:
As a reviewer please read through all the code lines and make sure that the code is fully understood, bug free, well-documented and well-structured.
General
Tests
If the Pull request introduces code that is not covered by the github action (for example coupling with a new library):
Scripts and Wiki
script/find_all_source_files.scp
to check the indentation of these files.License
doc/
(or already has one).