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

DOC - Enable viewing dev and stable versions of package documentation #206

Merged
merged 20 commits into from
Nov 14, 2023
Merged

DOC - Enable viewing dev and stable versions of package documentation #206

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
79d08cf
setup``conf.py``
Badr-MOUFAD Nov 8, 2023
244f19c
add version toggler
Badr-MOUFAD Nov 8, 2023
17f2856
version toggler: template and style
Badr-MOUFAD Nov 8, 2023
f9ebe62
is_stable_version ---> is_stable_doc & fix doc path
Badr-MOUFAD Nov 8, 2023
da81ec0
add comments
Badr-MOUFAD Nov 8, 2023
c94def1
update makefile to persist stable doc
Badr-MOUFAD Nov 9, 2023
784cd51
isolate instructions to add stable doc
Badr-MOUFAD Nov 9, 2023
4f4859d
stable in artifact
Badr-MOUFAD Nov 9, 2023
bdd3596
fix indentation
Badr-MOUFAD Nov 9, 2023
adff9e9
debug cd to doc after checkout dir
Badr-MOUFAD Nov 9, 2023
971e1ce
more on debugging
Badr-MOUFAD Nov 9, 2023
ad38244
more debugging
Badr-MOUFAD Nov 9, 2023
7588045
pull changes from gh-pages
Badr-MOUFAD Nov 9, 2023
a74cb74
missing semicolon in makefile
Badr-MOUFAD Nov 9, 2023
4629a51
workaround without ``cd ..``
Badr-MOUFAD Nov 9, 2023
0d8dfe0
rm semicolons
Badr-MOUFAD Nov 9, 2023
b97e469
clean ups makefile
Badr-MOUFAD Nov 9, 2023
76ae8bb
CI trigger
Badr-MOUFAD Nov 9, 2023
b99912b
version toggler before search bar
Badr-MOUFAD Nov 14, 2023
ee3be50
CI trigger
Badr-MOUFAD Nov 14, 2023
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
Prev Previous commit
Next Next commit
clean ups makefile
  • Loading branch information
@Badr-MOUFAD
Badr-MOUFAD committed Nov 9, 2023
commit b97e4696219143b459125f72db8cc6cb89dbdafc
2 changes: 1 addition & 1 deletion .circleci/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ jobs:
command: |
cd doc;
make clean;
make SPHINXOPTS=-v html-noplot;
make SPHINXOPTS=-v html;
cd ..;


Expand Down
6 changes: 0 additions & 6 deletions doc/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,17 +142,11 @@ install:

.PHONY: add-stable-doc
add-stable-doc:
pwd
ls
# switch to GITHUB_PAGES_BRANCH where stable build is located
git fetch origin $(GITHUB_PAGES_BRANCH)
git checkout $(GITHUB_PAGES_BRANCH)
git pull origin $(GITHUB_PAGES_BRANCH)
# move the content of the stable build to the output dir
pwd
ls
mv ../$(STABLE_DOC_DIR) $(OUTPUTDIR)
# switch back to main and get to doc directory
git checkout main
pwd
ls