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.md #667

Merged
merged 8 commits into from
Sep 28, 2022
Merged

Add DOCUMENTATION.md #667

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
8dc1ecb
Add DOCUMENTATION.md
harrism Sep 7, 2022
0f46ebb
Clarify input/output parameters and @pre preconditions.
harrism Sep 20, 2022
2e1913b
Add missing custom Doxyfile options.
harrism Sep 20, 2022
27bf6f7
Remove incorrect `make docs` command from docs.
harrism Sep 20, 2022
17634db
Add docs build command to cmakelists and docs.
harrism Sep 21, 2022
26ec837
Use find_doxygen
harrism Sep 27, 2022
44d904b
Add generator-independent build command
harrism Sep 27, 2022
d0d25bb
Apply suggestions from code review
harrism Sep 27, 2022
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
Prev Previous commit
Next Next commit
Remove incorrect make docs command from docs.
  • Loading branch information
@harrism
harrism committed Sep 20, 2022
commit 27bf6f7bcbabc5b9a4586a74e6124354f05ba7dd
8 changes: 3 additions & 5 deletions cpp/doc/DOCUMENTATION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -555,11 +555,9 @@ We recommend installing Doxygen using conda (`conda install doxygen`) or a Linux
[build and install doxygen from source](http://www.doxygen.nl/manual/install.html).

To build the libcuspatial HTML documentation simply run the `doxygen` command from the `cpp/doxygen`
directory containing the `Doxyfile`. The libcuspatial documentation can also be built using
`make docs_cuspatial` from the cmake build directory (e.g. `cpp/build`). Doxygen reads and processes
all appropriate source files under the `cpp/include/` directory. The output is generated in the
`cpp/doxygen/html/` directory. You can load the local `index.html` file generated there into any web
browser to view the result.
directory containing the `Doxyfile`. Doxygen reads and processes all appropriate source files under
the `cpp/include/` directory. The output is generated in the `cpp/doxygen/html/` directory. You can
load the local `index.html` file generated there into any web browser to view the result.

To view docs built on a remote server, you can run a simple HTTP server using Python:
`cd html && python -m http.server`. Then open `http://<IP address>:8000` in your local web browser,
Expand Down