Skip to content

Commit

Permalink
doc: remove notes about C++ gaps
Browse files Browse the repository at this point in the history
While there may still be gaps with the C++ support, we do have the most
common cases covered, and don't want to scare away potential users.
  • Loading branch information
jnikula committed Sep 11, 2024
1 parent 1243852 commit 4a3de14
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 12 deletions.
6 changes: 0 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,6 @@ documentation, and more. In short, Hawkmoth is Sphinx Autodoc for C/C++.
Hawkmoth aims to be a compelling alternative for documenting C and C++ projects
using Sphinx, mainly through its simplicity of design, implementation and use.

**Note**

The C++ support is still in early stages of development, and lacks some
fundamental features such as handling namespaces and documenting C++ specific
features other than classes.

.. _Sphinx: http://www.sphinx-doc.org

.. _C and C++ Domain: http://www.sphinx-doc.org/en/stable/domains.html
Expand Down
6 changes: 0 additions & 6 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,6 @@ Sphinx Autodoc for C/C++.
Hawkmoth aims to be a compelling alternative for documenting C and C++ projects
using Sphinx, mainly through its simplicity of design, implementation and use.

.. note::

The C++ support is still in early stages of development, and lacks some
fundamental features such as handling namespaces and documenting C++ specific
features other than classes.

Please see the `Hawkmoth project GitHub page`_ (or README.rst in the source
repository) for information on how to obtain, install, and contribute to
Hawkmoth, as well as how to contact the developers.
Expand Down

0 comments on commit 4a3de14

Please sign in to comment.