Skip to content

Commit

Permalink
chore: fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
mdtanker committed Jan 26, 2024
1 parent f9ffa54 commit d1cc66a
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
5 changes: 3 additions & 2 deletions .github/CONTRIBUTING.md
Expand Up @@ -223,7 +223,7 @@ The Docs are build with `Sphinx` and `Read the Docs`. Due to the above mentioned

#### Check the build manually (optional)

You can build the docs using:
You can build the docs using, but this will require pandoc to be install on your machine:

```bash
nox -s docs
Expand All @@ -232,8 +232,9 @@ nox -s docs
You can see a preview with:

```bash
nox -s docs -- serve
nox -s docs -- --serve
```

#### Automatically build the docs

Add, commit, and push all changes to GitHub in a Pull Request, and `RTD` should automatically build the docs.
Expand Down
Binary file modified docs/logo.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion pyproject.toml
Expand Up @@ -76,7 +76,6 @@ docs = [
"sphinx_design",
"nbsphinx",
"nbconvert",
"pandoc",
]
dev = [
"polartoolkit[interactive,viz,test,docs]",
Expand Down

0 comments on commit d1cc66a

Please sign in to comment.