[libcamera-devel,2/8] Documentation: contributing: Remove Sphinx + Doxygen integration

Message ID 20191021102453.26471-2-laurent.pinchart@ideasonboard.com
State Accepted
Commit bbc3be2fb5324aaef03101ff1b3ce26cae1b3edb
Headers show
Series
  • [libcamera-devel,1/8] Documentation: Move coding style under contributing
Related show

Commit Message

Laurent Pinchart Oct. 21, 2019, 10:24 a.m. UTC
Sphinx integration with Doxygen didn't produce the expected results, we
will not go that way. Don't mention it on the contributing page.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
 Documentation/contributing.rst | 5 -----
 1 file changed, 5 deletions(-)

Comments

Kieran Bingham Oct. 21, 2019, 10:57 a.m. UTC | #1
Hi Laurent,

On 21/10/2019 11:24, Laurent Pinchart wrote:
> Sphinx integration with Doxygen didn't produce the expected results, we
> will not go that way. Don't mention it on the contributing page.
> 
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

Absolutely. Good clean up.

Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>


> ---
>  Documentation/contributing.rst | 5 -----
>  1 file changed, 5 deletions(-)
> 
> diff --git a/Documentation/contributing.rst b/Documentation/contributing.rst
> index 390b96a55699..1cfbd0ec6b25 100644
> --- a/Documentation/contributing.rst
> +++ b/Documentation/contributing.rst
> @@ -42,13 +42,8 @@ Documentation
>  Project documentation is created using `Sphinx`_.  Source level documentation
>  uses `Doxygen`_.  Please make sure to document all code during development.
>  
> -Sphinx integration with Doxygen is planned, likely using `Breathe`_ and
> -`Exhale`_.
> -
>  .. _Sphinx: http://www.sphinx-doc.org
>  .. _Doxygen: http://www.doxygen.nl
> -.. _Breathe: https://breathe.readthedocs.io/en/latest/
> -.. _Exhale: https://exhale.readthedocs.io/en/latest/
>  
>  Submitting Patches
>  ------------------
>

Patch

diff --git a/Documentation/contributing.rst b/Documentation/contributing.rst
index 390b96a55699..1cfbd0ec6b25 100644
--- a/Documentation/contributing.rst
+++ b/Documentation/contributing.rst
@@ -42,13 +42,8 @@  Documentation
 Project documentation is created using `Sphinx`_.  Source level documentation
 uses `Doxygen`_.  Please make sure to document all code during development.
 
-Sphinx integration with Doxygen is planned, likely using `Breathe`_ and
-`Exhale`_.
-
 .. _Sphinx: http://www.sphinx-doc.org
 .. _Doxygen: http://www.doxygen.nl
-.. _Breathe: https://breathe.readthedocs.io/en/latest/
-.. _Exhale: https://exhale.readthedocs.io/en/latest/
 
 Submitting Patches
 ------------------