@@ -158,11 +158,11 @@ This will automatically create a git tag and trigger a Github workflow that crea
158
158
Please write documentation for new or changed features and use-cases.
159
159
This project uses [ sphinx] [ ] with the following features:
160
160
161
- - The [ myst] [ ] extension allows to write documentation in markdown/Markedly Structured Text
162
- - [ Numpy-style docstrings] [ numpydoc ] (through the [ napoloen] [ numpydoc-napoleon ] extension).
163
- - Jupyter notebooks as tutorials through [ myst-nb] [ ] (See [ Tutorials with myst-nb] ( #tutorials-with-myst-nb-and-jupyter-notebooks ) )
164
- - [ sphinx-autodoc-typehints] [ ] , to automatically reference annotated input and output types
165
- - Citations (like {cite: p }` Virshup_2023 ` ) can be included with [ sphinxcontrib-bibtex] ( https://sphinxcontrib-bibtex.readthedocs.io/ )
161
+ - The [ myst] [ ] extension allows to write documentation in markdown/Markedly Structured Text
162
+ - [ Numpy-style docstrings] [ numpydoc ] (through the [ napoloen] [ numpydoc-napoleon ] extension).
163
+ - Jupyter notebooks as tutorials through [ myst-nb] [ ] (See [ Tutorials with myst-nb] ( #tutorials-with-myst-nb-and-jupyter-notebooks ) )
164
+ - [ sphinx-autodoc-typehints] [ ] , to automatically reference annotated input and output types
165
+ - Citations (like {cite: p }` Virshup_2023 ` ) can be included with [ sphinxcontrib-bibtex] ( https://sphinxcontrib-bibtex.readthedocs.io/ )
166
166
167
167
See scanpy’s {doc}` scanpy:dev/documentation ` for more information on how to write your own.
168
168
@@ -186,10 +186,10 @@ please check out [this feature request][issue-render-notebooks] in the `cookiecu
186
186
187
187
#### Hints
188
188
189
- - If you refer to objects from other packages, please add an entry to ` intersphinx_mapping ` in ` docs/conf.py ` .
190
- Only if you do so can sphinx automatically create a link to the external documentation.
191
- - If building the documentation fails because of a missing link that is outside your control,
192
- you can add an entry to the ` nitpick_ignore ` list in ` docs/conf.py `
189
+ - If you refer to objects from other packages, please add an entry to ` intersphinx_mapping ` in ` docs/conf.py ` .
190
+ Only if you do so can sphinx automatically create a link to the external documentation.
191
+ - If building the documentation fails because of a missing link that is outside your control,
192
+ you can add an entry to the ` nitpick_ignore ` list in ` docs/conf.py `
193
193
194
194
(docs-building)=
195
195
0 commit comments