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

Add "Build the doc" section in the readme #941

Open
wants to merge 1 commit into
base: main
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
24 changes: 2 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ GraalVM to compile Java code to a native library.

Latest version of the documentation with API reference and many code samples is [here](https://pypowsybl.readthedocs.io/).

To contribute to the documentation follow the instructions in the [documentation README](https://github.com/powsybl/pypowsybl/tree/main/docs) page.

## Notebooks

Notebooks demonstrating PyPowSyBl features can be found in this [repository](https://github.com/powsybl/pypowsybl-notebooks).
Expand Down Expand Up @@ -133,25 +135,3 @@ To run linting inspection with `pylint`:
```bash
pylint pypowsybl
```

## Contribute to documentation

To run the tests included in the documentation:

```bash
cd docs/
make doctest
```

And then, to build the documentation:

```bash
make html
```

Web pages are generated in repository _build/html/ for preview before opening a pull request.
You can for example open it with firefox browser:

```bash
firefox _build/html/index.html
```
39 changes: 39 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# PyPowSyBl documentation

These are the documentation sources for PyPowSyBl features.

Please keep them up to date with your developments.
They are published on powsybl.readthedocs.io/ and pull requests are built and previewed automatically.

## Run

To run the tests included in the documentation:

```bash
make doctest
```

## Build the documentation

To locally build the documentation you can run one of these commands from the `docs` folder
~~~bash
sphinx-build -a . _build/html
~~~
Or
```bash
make html
```
Or to have the documentation in latex/pdf format
~~~bash
make latexpdf
~~~

## Preview the result

For html format, web pages are generated in repository _build/html/ and can be previewed opening a pull request.
You can for example open it with firefox browser:

```bash
firefox _build/html/index.html
```

Loading