Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Small documentation-related fixes #226

Merged
merged 5 commits into from
Nov 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -123,12 +123,25 @@ jobs:
for file in docs/tutorials/*/*nblink; do let "n_nblink+=1"; done;
n_ipynb=0; for file in examples/*ipynb; do let "n_ipynb+=1"; done;
if [[ $n_nblink != $n_ipynb ]]; then exit 1; fi;
check_urls:
runs-on: ubuntu-latest
name: Check all urls are valid
steps:
- uses: actions/checkout@v3
- uses: urlstechie/urlchecker-action@0.0.34
with:
file_types: .md,.py,.rst,.ipynb
print_all: false
timeout: 5
retry_count: 3

check:
if: always()
needs:
- notebooks
- tests
- all_tutorials_in_docs
- no_extra_nblinks
runs-on: ubuntu-latest
steps:
- name: Decide whether all tests and notebooks succeeded
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ metamer instances run for. We do this using

- Add a cell to the top of the notebook (under the import cell), add the
parameter tag (see [papermill
documentation]https://papermill.readthedocs.io/en/latest/usage-parameterize.html()),
documentation](https://papermill.readthedocs.io/en/latest/usage-parameterize.html),
and create a variable for each synthesis duration (e.g., `vgg16_synth_max_iter
= 1000`).
- Where synthesis is called later in the notebook, replace the number with the
Expand Down Expand Up @@ -309,7 +309,7 @@ that means nothing to you, don't worry!

Documentation comes in two types: `.rst` files (reST, the markup language used
by Sphinx, see
[here](https://www.sphinx-doc.org/en/main/usage/restructuredtext/basics.html)
[here](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html)
for a primer), which contain only text (including math) and images, and `.ipynb`
files (Jupyter notebooks), which also contain code.

Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ cite us! See the :ref:`citation` for more details.
synthesis
tips
reproducibility
Modules <api/modules>
API Documentation <api/modules>
tutorials/advanced/*

.. [Portilla2000] Portilla, J., & Simoncelli, E. P. (2000). A parametric texture
Expand Down