Skip to content

Commit

Permalink
Use mdbook to build readthedocs.
Browse files Browse the repository at this point in the history
  • Loading branch information
joaander committed May 16, 2024
1 parent 8c5c36f commit d421e11
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 16 deletions.
18 changes: 6 additions & 12 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -1,14 +1,8 @@
version: 2

build:
os: ubuntu-22.04
tools:
python: "3.12"

sphinx:
configuration: doc/conf.py
fail_on_warning: true

python:
install:
- requirements: doc/requirements.txt
os: "ubuntu-22.04"
commands:
- mkdir -p bin
- curl -sSL "https://github.com/rust-lang/mdBook/releases/download/v0.4.37/mdbook-v0.4.37-x86_64-unknown-linux-gnu.tar.gz" | tar -xvz --directory "bin"
- mkdir -p $READTHEDOCS_OUTPUT/html
- bin/mdbook build doc --dest-dir=$READTHEDOCS_OUTPUT/html
10 changes: 6 additions & 4 deletions doc/src/conda.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,9 @@ only from **conda-forge**. When you install [miniforge] with default options, re
If you are using a different conda compatible package manager, use the appropriate
`{{ package-manager }}` and `{{ environment-path }}`.

<div class="warning">Do not install any <i>MPI</i> or <i>GPU</i> enabled packages
from the <b>conda-forge</b> channel. The generic <i>MPI</i> and <i>CUDA</i> libraries
provided by <b>conda-forge</b> will take precedence and prevent the cluster-specific
libraries from operating correctly.</d>
<div class="warning">
Do not install any <i>MPI</i> or <i>GPU</i> enabled packages from the <b>conda-forge</b>
channel. The generic <i>MPI</i> and <i>CUDA</i> libraries provided by <b>conda-forge</
b> will take precedence and prevent the cluster-specific libraries from operating
correctly.
</div>

0 comments on commit d421e11

Please sign in to comment.