diff options
| author | Even Rouault <even.rouault@spatialys.com> | 2018-10-10 23:55:31 +0200 |
|---|---|---|
| committer | Even Rouault <even.rouault@spatialys.com> | 2018-10-11 01:33:18 +0200 |
| commit | 5511ab8f4d75d7df6712619c77d2fa3e5dc07f1c (patch) | |
| tree | 01dbfd34b47f7e1437ec82658fa75cab30d4f094 /docs/source/community | |
| parent | be58913801f400d9b00c8c3e8cdecb7e5fa89d38 (diff) | |
| download | PROJ-5511ab8f4d75d7df6712619c77d2fa3e5dc07f1c.tar.gz PROJ-5511ab8f4d75d7df6712619c77d2fa3e5dc07f1c.zip | |
RFC2: mention Breathe integration
Diffstat (limited to 'docs/source/community')
| -rw-r--r-- | docs/source/community/rfc/rfc-2.rst | 12 |
1 files changed, 10 insertions, 2 deletions
diff --git a/docs/source/community/rfc/rfc-2.rst b/docs/source/community/rfc/rfc-2.rst index 04b98321..fbeda111 100644 --- a/docs/source/community/rfc/rfc-2.rst +++ b/docs/source/community/rfc/rfc-2.rst @@ -788,8 +788,16 @@ Doxygen. .. _`Current snapshot of Class list`: http://even.rouault.free.fr/proj_cpp_api/html/annotated.html .. _`Spaghetti inheritance diagram`: http://even.rouault.free.fr/proj_cpp_api/html/inherits.html -It is not clear yet how this documentation can be integrated with the -general PROJ documentation with the reStructuredText format. +A basic integration of the Doxygen XML output into the general PROJ +documentation (using reStructuredText format) has been done with the the +Sphinx extension `Breathe`_, producing: + + * `One section with the C++ API`_ + * `One section with the C API`_ + +.. _`Breathe`: https://breathe.readthedocs.io/en/latest/ +.. _`One section with the C++ API`: http://even.rouault.free.fr/proj_cpp_api/rst_generated/html/development/reference/cpp/index.html +.. _`One section with the C API`: http://even.rouault.free.fr/proj_cpp_api/rst_generated/html/development/reference/functions.html#c-api-for-iso-19111-functionality Testing ------- |