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.

Sign up for GitHub

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 documentation on how to build the doxygen docs #183

Merged
1 commit merged into from
Oct 11, 2022
+9 −2
Merged

Add documentation on how to build the doxygen docs #183

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 9 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ More information can be found at: [Contributor Code of Conduct](CODE_OF_CONDUCT.

1. Find an issue to work on. The best way is to look for issues with the [good first issue](https://github.com/NVIDIA/SRF/issues) label.
2. Comment on the issue stating that you are going to work on it.
3. Code! Make sure to update unit tests and confirm that test coverage has not decreased (see below)! Ensure the
3. Code! Make sure to update unit tests and confirm that test coverage has not decreased (see below)! Ensure the
[license headers are set properly](#Licensing).
4. When done, [create your pull request](https://github.com/NVIDIA/SRF/compare).
5. Wait for other developers to review your code and update code as needed.
Expand All @@ -37,7 +37,7 @@ Remember, if you are unsure about anything, don't hesitate to comment on issues

## Unit testing and Code Coverage
Prior to submitting a pull request, you should ensure that all your contributed code is covered by unit tests, and that
unit test coverage percentages have not decreased (even better if they've increased). To test, from the SRF root
unit test coverage percentages have not decreased (even better if they've increased). To test, from the SRF root
directory:

1. Generate a code coverage report and ensure your additions are covered.
Expand Down Expand Up @@ -114,6 +114,13 @@ pip install -e $SRF_HOME/build/python
pytest $SRF_HOME/python
```

### Building API Documentation
From the root of the SRF repo, configure CMake with `SRF_BUILD_DOCS=ON` then build the `srf_docs` target. Once built the documentation will be located in the `build/docs/html` directory.
```bash
cmake -B build -DSRF_BUILD_DOCS=ON .
cmake --build build --target srf_docs
```

## Licensing
SRF is licensed under the Apache v2.0 license. All new source files including CMake and other build scripts should contain the Apache v2.0 license header. Any edits to existing source code should update the date range of the copyright to the current year. The format for the license header is:

Expand Down