Skip to content

Commit

Permalink
Update to match MasterDocDeploy doc generation with DocBuild doc gene… (
Browse files Browse the repository at this point in the history
#44)

* Update to match MasterDocDeploy doc generation with DocBuild doc generation
* Update to installation doc page

Signed-off-by: spagadar <[email protected]>
  • Loading branch information
SrikanthPagadarai authored Nov 14, 2024
1 parent 8d63180 commit 77086f6
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 4 deletions.
10 changes: 9 additions & 1 deletion .github/workflows/doc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions doc/reference.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
1 change: 0 additions & 1 deletion doc/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -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` |
Expand Down

0 comments on commit 77086f6

Please sign in to comment.