Skip to content

Commit

Permalink
fix typos
Browse files Browse the repository at this point in the history
  • Loading branch information
OriolAbril committed Nov 28, 2021
1 parent e291e63 commit 586dce7
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 5 deletions.
10 changes: 8 additions & 2 deletions doc/source/contributing/architecture.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
# Library architecture
ArviZ is organized in modules (the folders in [arviz directory](https://github.com/arviz-devs/arviz/tree/main/arviz)).
The main 3 modules are `data`, `plots` and `stats`.
Then we have 3 more folders. The [tests](https://github.com/arviz-devs/arviz/tree/main/arviz/tests) folder contains tests for all these 3 modules.
Then we have 3 more folders. The [tests](https://github.com/arviz-devs/arviz/tree/main/arviz/tests)
folder contains tests for all these 3 modules.

The [static](https://github.com/arviz-devs/arviz/tree/main/arviz/static) folder is only used to store style and CSS files to get HTML output for `InferenceData`. Finally we have the [wrappers](https://github.com/arviz-devs/arviz/tree/main/arviz/wrappers) folder that contains experimental (not tested yet either) features and interacts closely with both [data](https://github.com/arviz-devs/arviz/tree/main/arviz/data) and [stats](https://github.com/arviz-devs/arviz/tree/main/arviz/stats) modules.tecture
The [static](https://github.com/arviz-devs/arviz/tree/main/arviz/static)
folder is only used to store style and CSS files to get HTML output for `InferenceData`.
Finally we have the [wrappers](https://github.com/arviz-devs/arviz/tree/main/arviz/wrappers)
folder that contains experimental (not tested yet either) features
and interacts closely with both [data](https://github.com/arviz-devs/arviz/tree/main/arviz/data)
and [stats](https://github.com/arviz-devs/arviz/tree/main/arviz/stats) modules.

In addition, there are some files on the higher level directory: `utils.py`, `sel_utils.py`,
`rcparams.py` and `labels.py`.
2 changes: 1 addition & 1 deletion doc/source/contributing/diataxis_for_arviz.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ This translates for example into some duplicity when it comes to reference conte

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

This allows users who know the name of the function or who want to check the options
Expand Down
4 changes: 2 additions & 2 deletions doc/source/contributing/syntax_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,12 +109,12 @@ doc_guide
::::
:::::

Read more about the {ref}`Sphinx toctree directive <sphinx:table-of-contents>`.
Read more about the {ref}`Sphinx toctree directive <sphinx:toctree-directive>`.

(adding_references)=
## Adding references

In ArviZ docs, we use {confval}`sphinx:intersphinx_mapping` to add references to other libraies functions and objects.
In ArviZ docs, we use {confval}`sphinx:intersphinx_mapping` to add references to other libraries functions and objects.
The {mod}`~sphinx.ext.intersphinx` ensures us that cross-references to the target project exist.
It is the only way to link for multiversioned docs to link to themselves.
It raises a warning if the target references are changed or removed.
Expand Down

0 comments on commit 586dce7

Please sign in to comment.