Skip to content

Commit 16e3ca1

Browse files
authored
Fix .md format
1 parent 1b5c7bd commit 16e3ca1

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

{{cookiecutter.project_name}}/CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@ and this project adheres to [Semantic Versioning][].
1212

1313
### Added
1414

15-
- Basic tool, preprocessing and plotting functions
15+
- Basic tool, preprocessing and plotting functions

{{cookiecutter.project_name}}/docs/contributing.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -158,11 +158,11 @@ This will automatically create a git tag and trigger a Github workflow that crea
158158
Please write documentation for new or changed features and use-cases.
159159
This project uses [sphinx][] with the following features:
160160

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/)
166166

167167
See scanpy’s {doc}`scanpy:dev/documentation` for more information on how to write your own.
168168

@@ -186,10 +186,10 @@ please check out [this feature request][issue-render-notebooks] in the `cookiecu
186186

187187
#### Hints
188188

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`
193193

194194
(docs-building)=
195195

0 commit comments

Comments
 (0)