Skip to content

Commit 6b9dce4

Browse files
authored
[Documentation] Refactor documentation (#973)
1 parent cddbd83 commit 6b9dce4

6 files changed

Lines changed: 18 additions & 18 deletions

File tree

.github/workflows/pipeline.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ jobs:
176176
papermill notebooks/1-single-node.ipynb notebooks/1-single-node-out.ipynb -k python3
177177
flux start papermill notebooks/2-hpc-cluster.ipynb notebooks/2-hpc-cluster-out.ipynb -k python3
178178
flux start papermill notebooks/3-hpc-job.ipynb notebooks/3-hpc-job-out.ipynb -k python3
179-
papermill notebooks/4-developer.ipynb notebooks/4-developer-out.ipynb -k python3
179+
papermill notebooks/5-developer.ipynb notebooks/5-developer-out.ipynb -k python3
180180
181181
notebooks_integration:
182182
needs: [black]
@@ -198,8 +198,8 @@ jobs:
198198
shell: bash -l {0}
199199
timeout-minutes: 20
200200
run: |
201-
flux start papermill notebooks/5-1-gpaw.ipynb notebooks/5-1-gpaw-out.ipynb -k python3
202-
flux start papermill notebooks/5-2-quantum-espresso.ipynb notebooks/5-2-quantum-espresso-out.ipynb -k python3
201+
flux start papermill notebooks/4-1-gpaw.ipynb notebooks/4-1-gpaw-out.ipynb -k python3
202+
flux start papermill notebooks/4-2-quantum-espresso.ipynb notebooks/4-2-quantum-espresso-out.ipynb -k python3
203203
204204
unittest_flux_mpich:
205205
needs: [black]

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -144,8 +144,8 @@ as hierarchical job scheduler within the allocations.
144144
* [SLURM with Flux](https://executorlib.readthedocs.io/en/latest/3-hpc-job.html#slurm-with-flux)
145145
* [Flux](https://executorlib.readthedocs.io/en/latest/3-hpc-job.html#flux)
146146
* [Application](https://executorlib.readthedocs.io/en/latest/application.html)
147-
* [GPAW](https://executorlib.readthedocs.io/en/latest/5-1-gpaw.html)
148-
* [Quantum Espresso](https://executorlib.readthedocs.io/en/latest/5-2-quantum-espresso.html)
147+
* [GPAW](https://executorlib.readthedocs.io/en/latest/4-1-gpaw.html)
148+
* [Quantum Espresso](https://executorlib.readthedocs.io/en/latest/4-2-quantum-espresso.html)
149149
* [Trouble Shooting](https://executorlib.readthedocs.io/en/latest/trouble_shooting.html)
150150
* [Filesystem Usage](https://executorlib.readthedocs.io/en/latest/trouble_shooting.html#filesystem-usage)
151151
* [Firewall Issues](https://executorlib.readthedocs.io/en/latest/trouble_shooting.html#firewall-issues)
@@ -154,14 +154,14 @@ as hierarchical job scheduler within the allocations.
154154
* [Python Version](https://executorlib.readthedocs.io/en/latest/trouble_shooting.html#python-version)
155155
* [Resource Dictionary](https://executorlib.readthedocs.io/en/latest/trouble_shooting.html#resource-dictionary)
156156
* [SSH Connection](https://executorlib.readthedocs.io/en/latest/trouble_shooting.html#ssh-connection)
157-
* [Support & Contribution](https://executorlib.readthedocs.io/en/latest/4-developer.html)
158-
* [Issues](https://executorlib.readthedocs.io/en/latest/4-developer.html#issues)
159-
* [Pull Requests](https://executorlib.readthedocs.io/en/latest/4-developer.html#pull-requests)
160-
* [License](https://executorlib.readthedocs.io/en/latest/4-developer.html#license)
161-
* [Modules](https://executorlib.readthedocs.io/en/latest/4-developer.html#modules)
162-
* [Interface Class Hierarchy](https://executorlib.readthedocs.io/en/latest/4-developer.html#interface-class-hierarchy)
163-
* [Test Environment](https://executorlib.readthedocs.io/en/latest/4-developer.html#test-environment)
164-
* [Communication](https://executorlib.readthedocs.io/en/latest/4-developer.html#communication)
165-
* [External Libraries](https://executorlib.readthedocs.io/en/latest/4-developer.html#external-libraries)
166-
* [External Executables](https://executorlib.readthedocs.io/en/latest/4-developer.html#external-executables)
157+
* [Support & Contribution](https://executorlib.readthedocs.io/en/latest/5-developer.html)
158+
* [Issues](https://executorlib.readthedocs.io/en/latest/5-developer.html#issues)
159+
* [Pull Requests](https://executorlib.readthedocs.io/en/latest/5-developer.html#pull-requests)
160+
* [License](https://executorlib.readthedocs.io/en/latest/5-developer.html#license)
161+
* [Modules](https://executorlib.readthedocs.io/en/latest/5-developer.html#modules)
162+
* [Interface Class Hierarchy](https://executorlib.readthedocs.io/en/latest/5-developer.html#interface-class-hierarchy)
163+
* [Test Environment](https://executorlib.readthedocs.io/en/latest/5-developer.html#test-environment)
164+
* [Communication](https://executorlib.readthedocs.io/en/latest/5-developer.html#communication)
165+
* [External Libraries](https://executorlib.readthedocs.io/en/latest/5-developer.html#external-libraries)
166+
* [External Executables](https://executorlib.readthedocs.io/en/latest/5-developer.html#external-executables)
167167
* [Interface](https://executorlib.readthedocs.io/en/latest/api.html)

docs/_toc.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ chapters:
77
- file: 3-hpc-job.ipynb
88
- file: application.md
99
sections:
10-
- file: 5-1-gpaw.ipynb
11-
- file: 5-2-quantum-espresso.ipynb
10+
- file: 4-1-gpaw.ipynb
11+
- file: 4-2-quantum-espresso.ipynb
1212
- file: trouble_shooting.md
13-
- file: 4-developer.ipynb
13+
- file: 5-developer.ipynb
1414
- file: api.rst

0 commit comments

Comments
 (0)