Skip to content

Commit

Permalink
Simplify the documentation of how to build the docs locally (and corr…
Browse files Browse the repository at this point in the history
…ect the version to an rc version)
  • Loading branch information
mirkobunse committed Sep 19, 2024
1 parent 2c422a1 commit 8101f48
Show file tree
Hide file tree
Showing 6 changed files with 4 additions and 70 deletions.
1 change: 0 additions & 1 deletion docs/.gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
build/
source/*.rst
20 changes: 0 additions & 20 deletions docs/Makefile

This file was deleted.

35 changes: 0 additions & 35 deletions docs/make.bat

This file was deleted.

7 changes: 2 additions & 5 deletions docs/source/developer-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,8 @@ As soon as you push to the `main` branch, GitHub Actions will take out these uni
After locally building the documentation, open `docs/build/html/index.html` in your browser.

```bash
. venv/bin/activate
pip install -e .[docs]
cd docs/
sphinx-apidoc --force --output-dir source/ ../qunfold
make html
venv/bin/pip install -e .[docs]
venv/bin/sphinx-build -M html docs/source docs/build
```

As soon as you push to the `main` branch, GitHub Actions will build the documentation, push it to the `gh-pages` branch, and publish the result on GitHub Pages: [https://mirkobunse.github.io/qunfold](https://mirkobunse.github.io/qunfold)
Expand Down
9 changes: 1 addition & 8 deletions docs/source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ The Python package [qunfold](https://github.com/mirkobunse/qunfold) implements o
## Installation

```
pip install --upgrade pip setuptools wheel
pip install 'qunfold @ git+https://github.com/mirkobunse/qunfold'
```

Expand All @@ -32,14 +33,6 @@ To upgrade an existing installation of `qunfold`, run
pip install --force-reinstall --no-deps 'qunfold @ git+https://github.com/mirkobunse/qunfold@main'
```

### Troubleshooting

Starting from `pip 23.1.2`, you have to install `setuptools` and `wheel` explicitly. If you receive a "NameError: name 'setuptools' is not defined", you need to execute the following command before installing `qunfold`.

```
pip install --upgrade pip setuptools wheel
```


## Usage

Expand Down
2 changes: 1 addition & 1 deletion qunfold/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
__version__ = "0.1.5"
__version__ = "0.1.5-rc"

from .losses import (
instantiate_loss,
Expand Down

0 comments on commit 8101f48

Please sign in to comment.