Skip to content

Commit 27cb978

Browse files
committed
🧱 Add tutorials from its own repo
1 parent 3618e54 commit 27cb978

File tree

5 files changed

+22
-3
lines changed

5 files changed

+22
-3
lines changed

.circleci/config.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
version: 2.1
22
commands:
3+
get-tutorials:
4+
steps:
5+
- run:
6+
name: 👽️ Getting user tutorials
7+
command: |
8+
sudo apt-get update
9+
sudo apt-get -y install git
10+
git clone --depth 1 https://github.com/FCP-INDI/C-PAC_tutorials.git docs/_sources/user/tutorials
311
get-version:
412
steps:
513
- run:
@@ -111,6 +119,7 @@ jobs:
111119
- install-build-dependencies:
112120
version: develop
113121
- run-cpac-commands
122+
- get-tutorials
114123
- run:
115124
name: 🏗️ Building nightly branch docs
116125
command: ./bin/build nightly

CONTRIBUTING.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
- [Let CircleCI build your drafts / works-in-progress](#let-circleci-build-your-drafts--works-in-progress)
1010
- [Build locally (C-PAC ≥ v1.8.0)](#build-locally-c-pac-≥-v180)
1111
- [Flowcharts](#flowcharts)
12+
- [Tutorials](#tutorials)
1213
- [References and citations](#references-and-citations)
1314
- [Environment notes](#environment-notes)
1415

@@ -119,6 +120,11 @@ where `{width}` and `{height}` are the values already present in the existing `w
119120
<object data="../_static/path/to/chart.svg" type="image/svg+xml"></object>
120121
```
121122

123+
<a id="markdown-tutorials" name="tutorials"></a>
124+
## Tutorials
125+
126+
See [FCP-INDI/C-PAC_tutorials/CONTRIBUTING.md](https://github.com/FCP-INDI/C-PAC_tutorials/blob/main/CONTRIBUTING.md) for how to contribute tutorials. Add them to the TOC tree in that repository or in any TOC tree in this repository with a relative path beginning `/user/tutorials/` (e.g., `/user/tutorials/observed_usage` for [`observed_usage.ipynb`](https://github.com/FCP-INDI/C-PAC_tutorials/blob/main/observed_usage.ipynb)).
127+
122128
<a id="markdown-references-and-citations" name="references-and-citations"></a>
123129
## References and citations
124130

docs/_sources/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,7 @@ def yaml_to_rst(path):
148148
'sphinx.ext.viewcode',
149149
'sphinxcontrib.programoutput',
150150
'exec',
151+
'nbsphinx',
151152
'numpydoc']
152153

153154
# Add any paths that contain templates here, relative to this directory.

docs/_sources/user/index.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,7 @@ User Guide Index
113113
6. All Run Options <running>
114114
7. Run Group Analysis <group_analysis>
115115
8. Check Your Outputs <output_dir>
116-
9. Troubleshoot <help>
117-
10. Release Notes <rnotes>
118-
11. Appendix <appendix>
116+
9. Tutorials <tutorials/index>
117+
10. Troubleshoot <help>
118+
11. Release Notes <rnotes>
119+
12. Appendix <appendix>

requirements.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1+
bash_kernel
12
docutils<0.18
23
m2r
34
mistune==0.8.4
5+
nbsphinx
46
numpydoc
57
PyGithub
68
sphinx

0 commit comments

Comments
 (0)