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

Include Doxygen build #89

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
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
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,8 @@ doc/tex/*.gitinfo
doc/tex/*.synctex.gz
doc/tex/*.pdf
doc/tex/docs/*.aux
doc/doxyoutput/
doc/api/

### Ignore IDE files ###
.vs/
Expand Down
43 changes: 33 additions & 10 deletions doc/README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,44 @@
## CADET Documentation
# CADET Documentation

This document provides instructions for building CADET documentation locally and for all releases and branches.

To build the documentation locally, install sphinx and other dependencies by running
## Prerequisites

```
pip install -r requirements.txt
Ensure you have [mamba](https://mamba.readthedocs.io/en/latest/installation.html) installed on your system.

```
## Building Documentation Locally

1. **Navigate to the `doc` folder**:

```sh
cd <root>/doc/
```

2. **Create and activate the documentation environment**:

Then, in the `doc` folder run:
```sh
mamba env create -f ./environment.yml
mamba activate cadet-core-docs
```

`sphinx-build -b html . build`
3. **Build the documentation**:

The output is in the `build` directory and can be opened with any browser.
```sh
sphinx-build -b html . build
```

The output is in the `build` directory and can be opened with any browser.

## Building Documentation for All Releases and Branches

To build the documentation for all releases and the master branch, run:

`sphinx-multiversion ./ ./build/`.
```sh
sphinx-multiversion ./ ./build/ -D 'exhale_args.containmentFolder=${sourcedir}/api'
```

Any changes to the documentation will automatically be pushed to the github-pages repository (https://github.com/cadet/cadet.github.io) using github actions.
On Windows, use the following command:

```powershell
sphinx-multiversion ./ ./build/ -D exhale_args.containmentFolder=${sourcedir}/api
```
Loading
Loading