Skip to content

Commit 77f2f9e

Browse files
authored
Nick/contributing tutorial (#367)
* Internal: Try new link checker * Internal: Add codespell and fix typos. * Internal: See if codespell precommit finds config. * Internal: Found config. Now enable reading it * MATLAB: Add initial support for more matlab support. * DEV: Updating contributing doc for more details on adding a tutorial Closes #366
1 parent 81e5217 commit 77f2f9e

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

CONTRIBUTING.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,28 @@ current or filing a new [issue](https://github.com/sandialabs/pyttb/issues).
7676
```
7777
2. Clear notebook outputs if run locally see `nbstripout` in our [pre-commit configuration](.pre-commit-config.yaml)
7878

79+
### Adding tutorials
80+
81+
1. Follow general setup from above
82+
1. Checkout a branch to make your changes
83+
1. Install from source with dev and doc dependencies
84+
1. Verify you can build the existing docs with sphinx
85+
86+
1. Create a new Jupyter notebook in [./docs/source/tutorial](./docs/source/tutorial)
87+
1. Our current convention is to prefix the filename with the type of tutorial and all lower case
88+
89+
1. Add a reference to your notebook in [./docs/source/tutorials.rst](./docs/source/tutorials.rst)
90+
91+
1. Rebuild the docs, review locally, and iterate on changes until ready for review
92+
93+
#### Tutorial References
94+
Generally, inspecting existing documentation or tutorials should provide a reasonable starting point for capabilities,
95+
but the following links may be useful if that's not sufficient.
96+
97+
1. We use [sphinx](https://www.sphinx-doc.org/) to automatically build our docs and may be useful for `.rst` issues
98+
99+
1. We use [myst-nb](https://myst-nb.readthedocs.io/) to render our notebooks to documentation
100+
79101
## GitHub Workflow
80102

81103
### Proposing Changes

0 commit comments

Comments
 (0)