Skip to content

Commit

Permalink
Improve readability of doc for doc gen.
Browse files Browse the repository at this point in the history
  • Loading branch information
clebreto committed Sep 25, 2024
1 parent a12985e commit 8e24b5a
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,31 @@

The documentation is based on a combination of Sphinx parsing Exhale rst output genrated from Doxygen xml output.

## Dependencies

It requires installing some dependencies, installation that can be leverage using pip.

To install the dependencies to build the documentation:

``` shell
pip install -r docs/requirements.txt
```
## Documentation generation

Following that, the corese-core documentation can be generated through a single call to sphinx-multiversion from the root directory of corese-core:

``` shell
sphinx-multiversion docs/source build/html -D 'exhale_args.containmentFolder=${sourcedir}/java_api' -v
```
## Switcher generation

- To navigate between versions by means of the switcher (the dropdown list indicating the available version), the switcher.json object must be generated.
- To improve navigability, a landing page must also be generated to redirect to the latest version of the documentation.

To navigate between versions by means of the switcher (the dropdown list idicating the available version), the switcher.json object must be generated. To improve navigability, a landing page must also be generated to redirect to the latest version of the documentation. To this end a script must be executed and write the output to the output html directory:
To this end a script must be executed and write the output to the output html directory:

```shell
./docs/switcher_generator.sh build/html/switcher.json build/html/index.html
```

Both sphinx-multiversion and switcher_generator work on tags following the ``^v[0-9]+\.[0-9]+\.[0-9]+$` syntax, they are ordered by ref name.
Both sphinx-multiversion and switcher_generator work on tags following the ``^v[0-9]+\.[0-9]+\.[0-9]+$` syntax and ordered by refname.

0 comments on commit 8e24b5a

Please sign in to comment.