diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml index ee09cd5..33abd8c 100644 --- a/.github/workflows/doc.yml +++ b/.github/workflows/doc.yml @@ -57,8 +57,16 @@ jobs: mkdir -p build cd build cmake .. -DBUILD_DOC=ON + make genalyzer -j4 + sudo make install genalyzer + sudo ldconfig + cd ../bindings/python + pip install ".[tools]" + cd ../../build + sudo rm -rf * + sudo rm ../doc/reference_simplified.md + cmake .. -DBUILD_DOC=ON make Sphinx - cd .. - name: Publish doc uses: peaceiris/actions-gh-pages@v3 diff --git a/doc/reference.md b/doc/reference.md index 6806c23..735d15f 100644 --- a/doc/reference.md +++ b/doc/reference.md @@ -1,6 +1,6 @@ -# Advanced API Reference +# API Reference -Advanced API Reference for Genalyzer library. This API is meant for advanced users who want to use the library functions for more complex tasks. +API Reference for Genalyzer library. ## Table of Contents diff --git a/doc/setup.md b/doc/setup.md index 3cd18d0..9634c15 100644 --- a/doc/setup.md +++ b/doc/setup.md @@ -71,7 +71,6 @@ sudo make install | Option | Description | Default | | ------ | ----------- | ------- | -| `PYTHON_BINDINGS` | Build the Python bindings | `OFF` | | `BUILD_DOC` | Build the documentation | `OFF` | | `BUILD_TESTS_EXAMPLES` | Build the tests and examples | `OFF` | | `COVERAGE` | Enable coverage tracing when testing | `OFF` |