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

Add Readthedoc feature #15

Merged
merged 62 commits into from
Jun 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
62 commits
Select commit Hold shift + click to select a range
3845af3
add readthedoc yaml file
shenvitor Jun 4, 2024
52bbc60
add essential set-up files if using rtd
shenvitor Jun 6, 2024
5e5a047
more essential set-up files if using rtd
shenvitor Jun 6, 2024
3d345c2
directory specification
shenvitor Jun 6, 2024
1f6e247
location rename
shenvitor Jun 6, 2024
95f69ce
install rtd theme
shenvitor Jun 6, 2024
2892baa
rst file
shenvitor Jun 6, 2024
9d6d073
hello
shenvitor Jun 6, 2024
05ebb94
hello world
shenvitor Jun 6, 2024
0ea61f2
yaml file confy file location
shenvitor Jun 6, 2024
a20a5de
adjust to mystnb
shenvitor Jun 7, 2024
99fe394
Adjust configuration for RTD
shenvitor Jun 7, 2024
a5ed974
Ensure _static directory exists
shenvitor Jun 7, 2024
85f269e
add python version in git workflow ci file
shenvitor Jun 7, 2024
b227762
Ensure _static directory exists with a .keep file
shenvitor Jun 7, 2024
1635fc9
make _templates directory exists with a .keep file
shenvitor Jun 7, 2024
6670cf0
update most of the request changes
shenvitor Jun 11, 2024
3b72423
Remove pyproject.toml and rely on pixi.toml
shenvitor Jun 11, 2024
9be9505
Remove requirements.txt and update .readthedoc.yaml
shenvitor Jun 11, 2024
514ea3c
Add build-docs.sh and update .readthedoc.yaml
shenvitor Jun 11, 2024
cead558
update commands in .readthedoc.yaml
shenvitor Jun 11, 2024
9f23541
add custom build steps in .readthedoc.yaml
shenvitor Jun 11, 2024
470bfc9
pixi shell custom build steps in .readthedoc.yaml
shenvitor Jun 11, 2024
9296e67
pixi install custom build steps in .readthedoc.yaml
shenvitor Jun 11, 2024
ecd5520
pixi custom build steps in .readthedoc.yaml
shenvitor Jun 11, 2024
8c789c1
pixi source custom build steps in .readthedoc.yaml
shenvitor Jun 11, 2024
de092ce
pixi source at home folder custom build steps in .readthedoc.yaml
shenvitor Jun 11, 2024
11b18ce
custom build steps in RTD yaml
shenvitor Jun 11, 2024
109788b
pixi location
shenvitor Jun 11, 2024
d50722c
in 1 line
shenvitor Jun 11, 2024
f4d5473
change to command
shenvitor Jun 11, 2024
b7c23f1
change back to build
shenvitor Jun 11, 2024
3872f23
jobs
shenvitor Jun 11, 2024
1066b68
pixi install shell
shenvitor Jun 11, 2024
c764ba7
export
shenvitor Jun 11, 2024
ef82961
remove pixi shell in rtd yaml
shenvitor Jun 11, 2024
13a82a2
modify again in rtd yaml
shenvitor Jun 11, 2024
20d6256
correction again in rtd yaml
shenvitor Jun 11, 2024
276d103
change sphinx in rtd yaml
shenvitor Jun 11, 2024
94c5c4b
move to above in rtd yaml
shenvitor Jun 11, 2024
7085d98
remove commands in rtd yaml
shenvitor Jun 11, 2024
657d996
post_build
shenvitor Jun 11, 2024
3b4f9ad
only essentials in post_install
shenvitor Jun 11, 2024
5b812ce
location update
shenvitor Jun 11, 2024
5d2025d
stucks here
shenvitor Jun 11, 2024
bd5d1e2
add build_commends maybe
shenvitor Jun 11, 2024
dd52c07
again post build maybe
shenvitor Jun 11, 2024
8a9dbde
add back python maybe
shenvitor Jun 11, 2024
e63b382
wrap into post_install
shenvitor Jun 11, 2024
980f254
add pre_biild
shenvitor Jun 12, 2024
8e35409
add install before pre_biild
shenvitor Jun 12, 2024
5523780
try only pixi shell in pre_biild
shenvitor Jun 12, 2024
6a051d7
attempt to run command bypassing the need of an interactive shell in …
shenvitor Jun 12, 2024
e5992b4
only pixi shell and then python
shenvitor Jun 12, 2024
0ca76fa
Add back pyproject again
shenvitor Jun 12, 2024
c2c8b15
remove build-docs.sh
shenvitor Jun 12, 2024
d760eeb
remove pyproject again
shenvitor Jun 12, 2024
f7231ef
update .readthedoc.yaml by an example
shenvitor Jun 17, 2024
5c3746c
reduce diff with main branch
shenvitor Jun 17, 2024
653cd5f
Merge branch 'main' into readthedoc
shenvitor Jun 17, 2024
418daad
remove cell timeout and print traceback
shenvitor Jun 17, 2024
7fee9c9
move html output to RTD location
shenvitor Jun 17, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# GitHub syntax highlighting
pixi.lock linguist-language=YAML
10 changes: 10 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
version: "2"
build:
os: "ubuntu-22.04"
tools:
python: mambaforge-latest
commands:
- mamba install -c conda-forge -c nodefaults pixi
- pixi install
- pixi run docnb
- pixi run "rm -rf $READTHEDOCS_OUTPUT/html && cp -r docs/_build/html $READTHEDOCS_OUTPUT/html"
2 changes: 2 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,7 @@
"html_image",
"smartquotes",
]
nb_execution_show_tb = True
nb_execution_timeout = -1
nitpicky = True
project = "GlueX N-Star"