Skip to content

Commit 5aa5c4c

Browse files
authored
rename sphinx_docs -> Docs (#1689)
this syncs up with Castro
1 parent ab820ce commit 5aa5c4c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+1593
-11
lines changed

.github/workflows/docs-test.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,10 @@ jobs:
3535

3636
- name: Build docs
3737
run: |
38-
cd sphinx_docs/
38+
cd Docs/
3939
make SPHINXOPTS='-v -W --keep-going' html
4040
4141
- name: Link check
4242
run: |
43-
cd sphinx_docs/
43+
cd Docs/
4444
make SPHINXOPTS=-v linkcheck

.gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ extern.f90
7878
# sphinx
7979
build/
8080
doxy_files
81-
sphinx_docs/source/runtime_parameters.rst
81+
Docs/source/runtime_parameters.rst
8282

8383

8484
# C++ parameters

sphinx_docs/Doxyfile Docs/Doxyfile

File renamed without changes.

sphinx_docs/Makefile Docs/Makefile

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

sphinx_docs/rp.py Docs/rp.py

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

sphinx_docs/source/design.rst Docs/source/design.rst

+2-2
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

Docs/source/runtime_parameters.rst

+1,580
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

README.md

+4-2

deploy_docs_action.sh

+4-4
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,19 @@ mkdir out
1212
# if on the dev branch, use the dev_layout.html template to get the
1313
# links correct
1414
if [ "$GITHUB_BRANCH" = "$DEV_BRANCH" ]; then
15-
mv sphinx_docs/source/_templates/dev_layout.html sphinx_docs/source/_templates/layout.html
15+
mv Docs/source/_templates/dev_layout.html Docs/source/_templates/layout.html
1616
fi
1717

1818
# Build the Sphinx documentation
19-
cd sphinx_docs
19+
cd Docs
2020
make html
2121
cd ../
2222

2323
mkdir -p out/docs/
2424
if [ "$GITHUB_BRANCH" = "$MAIN_BRANCH" ]; then
2525
mkdir -p out/docs
26-
mv sphinx_docs/build/html/* out/docs
26+
mv Docs/build/html/* out/docs
2727
else
2828
mkdir -p out/docs/dev/
29-
mv sphinx_docs/build/html/* out/docs/dev
29+
mv Docs/build/html/* out/docs/dev
3030
fi

0 commit comments

Comments
 (0)