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

New docs only on v-tag #16

Merged
merged 1 commit into from
May 20, 2023
Merged
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
4 changes: 2 additions & 2 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,9 @@ jobs:

deploy:
needs: build
if: github.ref == 'refs/heads/main'
# if: github.ref == 'refs/heads/main'
# todo, switch to update pages only for new releases
# if: startsWith(github.ref, 'refs/tags/v')
if: startsWith(github.ref, 'refs/tags/v')
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
Expand Down
4 changes: 2 additions & 2 deletions doc/doc.dox
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,15 @@ The project has the following dependencies:
\li Optional: <a href="https://www.doxygen.nl">doxygen</a> for buliding the documentation
\li Optional: <a href="https://github.com/doctest/doctest">doctest</a> for unit testing

If doxygen is not found, it will not be possible to build the documentation.
If doxygen is not found it will not be possible to build the documentation.

doctest is fetched on demand, except if \c BUILD_TESTING is set to OFF.

\subsection build Building the library

The library can be build with CMake. No surprises here.

On Linux, the configure and build process might be as follows:
On Linux, the configure and build process might appear as follows:

\code
cmake -B build -S . -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr/local
Expand Down