Skip to content

Commit f76dc7d

Browse files
committed
Update in-depth explanations
1 parent 7029785 commit f76dc7d

File tree

4 files changed

+5
-31
lines changed

4 files changed

+5
-31
lines changed

docs/source/contributing/diataxis_for_arviz.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ which can nor should follow the Diátaxis framework.
3333
ArviZ is a library with a strong visualization component.
3434
This translates for example into some duplicity when it comes to reference content.
3535

36-
Both the {ref}`example_gallery` and the {ref}`api` pages are reference content.
36+
Both the {ref}`arviz_plots:example_gallery` and the {ref}`arviz_plots:api` pages are reference content.
3737
The API reference indexes by name and contains the description of each object,
3838
whereas the Example Gallery indexes by image and to avoid excessive duplication,
3939
links to the respective API page.

docs/source/contributing/doc_toolchain.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
11
(doc_toolchain)=
22
# Documentation toolchain
33

4+
:::{caution} Some content in this page may be outdated.
5+
:::
6+
47
ArviZ documentation is built using a Python documentation tool, [Sphinx](https://www.sphinx-doc.org/en/master/).
58
Sphinx converts `rst`(restructured text) files into HTML websites.
69
There are different extensions available for converting other types of files
7-
like markdown, jupyter notebooks, etc. into HTML websites.
10+
like markdown, Jupyter notebooks, etc. into HTML websites.
811

912
ArviZ [docs](https://github.com/arviz-devs/arviz/tree/main/doc/source) consist of `.rst`, `.md` and `.ipynb` files.
1013
It uses `myst-parser` and `myst-nb` for `.md` and `.ipynb` files.

docs/source/contributing/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,5 +171,4 @@ syntax_guide
171171

172172
doc_toolchain
173173
diataxis_for_arviz
174-
plotting_backends
175174
:::

docs/source/contributing/plotting_backends.md

Lines changed: 0 additions & 28 deletions
This file was deleted.

0 commit comments

Comments
 (0)