Skip to content

Commit

Permalink
📝 Take feedback into account
Browse files Browse the repository at this point in the history
  • Loading branch information
theogiraudet committed Jun 24, 2024
1 parent 2ded297 commit d7f5f8f
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
5 changes: 3 additions & 2 deletions docs/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
- ([218](https://github.com/Gunivers/Bookshelf/pull/218)) Enhanced speed of factorial function in `bs.math`.

### 📄 Documentation
([215](https://github.com/Gunivers/Bookshelf/issues/215)) The is now documentation about the documentation (kind of metadocumentation?).
- ([215](https://github.com/Gunivers/Bookshelf/issues/215)) There is now documentation about the documentation (kind of metadocumentation?).

---

Expand All @@ -23,7 +23,6 @@ Bookshelf is now based on **Minecraft 1.21**.

### 🎉 Addition
- ([187](https://github.com/Gunivers/Bookshelf/issues/187)) Add `#bs.block:map_type` and `#bs.block:mix_type` functions.
- ([187](https://github.com/Gunivers/Bookshelf/issues/187)) Add `#bs.block:map_type` and `#bs.block:mix_type` functions.

### 🐛 Fixes
- ([211](https://github.com/Gunivers/Bookshelf/pull/211)) Add missing help function tag in `bs.link`.
Expand All @@ -45,6 +44,8 @@ Bookshelf is now based on **Minecraft 1.21**.
- Added templates for issues.
- ([#199](https://github.com/Gunivers/Bookshelf/pull/199)) The different metadata (the manually specified one and the generated one) are now automatically verified at each commit inside a pull request. This prevents them from being forgotten. More information [here](project:contribute/contribution-validation.md).

---

## 📦 Bookshelf - 2.0.0

```{admonition} Breaking changes
Expand Down
13 changes: 6 additions & 7 deletions docs/contribute/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,15 @@ This page aims to give some information on how to contribute to the documentatio

## ⚙️ Install the required tools

Bookshelf documentation requires Python to be built.
Bookshelf documentation requires Python.
If you are not familiar with this programming language, don't worry, you don't have to use it.
But to be able to build locally the documentation locally, you will still need to install it.
For that, you can download it on the [Python website](https://www.python.org/downloads/).
We recommend the Python version 3.12.
But to be able to build the documentation locally, you still need to install it.
For that, you can download version 3.12 or higher on the [Python website](https://www.python.org/downloads/).
After having installed Python and cloned the Bookshelf repository, go on the `/docs` folder and open a terminal (or Powershell if you are on Windows).
Then, execute this command:

```shell
pip install -r requirements.txt
pip install -r requirements.txt -U
```

This command will install all the required dependencies, especially [Sphinx](https://www.sphinx-doc.org/en/master/) and [Myst Parser](https://myst-parser.readthedocs.io/en/latest/intro.html) that enable the generation of the documentation website from the different Markdown files.
Expand All @@ -36,8 +35,8 @@ All the images are stored into the `/docs/_imgs` folder.

## 🔨 Build the documentation locally

To verify on your computer if your contribution to the documentation works correctly, you can build the documentation locally.
To do this, go to the `/docs` folder and open a terminal (or Powershell if you are on Windows).
To ensure your documentation contribution works correctly, you can build and verify it locally on your computer.
To do this, navigate to the `/docs` folder and open a terminal (or Powershell if you are on Windows).
Then, execute this command:

```shell
Expand Down

0 comments on commit d7f5f8f

Please sign in to comment.