Skip to content

Commit

Permalink
Fix documentation (#1061)
Browse files Browse the repository at this point in the history
* documentation : fix the README.md of the documetation and add fwe lines about readthedocs configuration file

* documentation : Update the install instructions of the Vscode extension
  • Loading branch information
Alidra authored Feb 29, 2024
1 parent 58b80a9 commit 4b82a2f
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 4 deletions.
11 changes: 7 additions & 4 deletions doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,10 @@ Where do I start?

The documentation is available at <https://lambdapi.readthedocs.io>.

It can also be generated from the sources and browsed locally using any web
The online documentation generation is triggered each time new code is pushed to the master branch of the lambdapi repository on Github.
To this end, make sure the `.readthedocs.yaml` file is placed in the top-most directory of the Lambdapi repository and contains the well-suited configuration instructions as described in the [readthedocs documentation](https://docs.readthedocs.io/en/stable/config-file/index.html).

The Lamdbapi user manual can also be generated from the sources and browsed locally using any web
browser.

To generate the documentation, [Sphinx](https://www.sphinx-doc.org/)
Expand All @@ -26,9 +29,9 @@ sudo apt install python3-pip
pip install -U sphinx sphinx_rtd_theme
```

Change to directory `docs/` from the root of the sources
and use `make html` to generate `html` files into `docs/_build/html`.
The entry point of the documentation is `docs/_build/html/index.html`.
Change to directory `doc/` from the root of the sources
and use `make html` to generate `html` files into `doc/_build/html`.
The entry point of the documentation is `doc/_build/html/index.html`.

How do I contribute?
--------------------
Expand Down
9 changes: 9 additions & 0 deletions editors/vscode/INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,15 @@ export PATH=$node_dir:$PATH
export NODE_PATH=$node_dir/lib/node_modules:$NODE_PATH
```

Please note that adding nodejs to the `$PATH` by executing the `export` commands from the terminal will make it work only in the terminal where these commands have been run.

Thus, you need to re-execute them each time you work from a new terminal.
If you intend to do this often, it is recomanded to add the two `export` commands to your `~/.bashrc` or `~/.profile` files and then apply changes with :
```bash
source ~/.bashrc
source ~/.profile
```

- install dependencies:

```bash
Expand Down

0 comments on commit 4b82a2f

Please sign in to comment.