diff options
| author | Aina Niemetz <aina.niemetz@gmail.com> | 2021-04-07 12:15:31 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-04-07 19:15:31 +0000 |
| commit | 887a75715761767bb7fd7b1d71e188399a4edd3b (patch) | |
| tree | af6e47920d9443915ba8a97d12c7607a3ca7759c /docs/index.rst | |
| parent | 04a494e251a8cc2c90bb429e2858f1c4eb8f88ff (diff) | |
New C++ Api: Initial setup of Api documentation. (#6295)
This configures the initial setup for generating Api documentation with
Sphinx via Breathe and Doxygen. All fixes in the documentation of the
cvc5.h header are for the purpose of eliminating warnings. This PR does
not check for completeness of the documentation, and does not yet tweak
the documentation to be nice, beautiful and consistent, which is
postponed to future PRs.
Configure with `--docs`, and then make. This will generate a `docs`
directory in the build directory. The Sphinx documentation can be found
at `build/docs/sphinx/index.html`. Doxygen documentation is only
generated as xml under `build/docs/doxygen`.
This PR further proposes a new style for copyright headers. If this
style is approved, I will submit a PR to update the update_copyright.pl
script.
Diffstat (limited to 'docs/index.rst')
| -rw-r--r-- | docs/index.rst | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 000000000..645561f2b --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,23 @@ +.. cvc5 documentation master file, created by + sphinx-quickstart on Mon Apr 5 17:02:33 2021. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +cvc5 API Documentation +====================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + +--------------- + +* :ref:`genindex` +* :ref:`search` + + +C++ API Documentation +--------------------- + +.. doxygenfile:: cvc5.h |