Skip to content

Doxygen+Sphinx+Breathe = Inline Documentation #582

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.

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

Merged
merged 1 commit into from
Jan 12, 2016

Conversation

deanberris
Copy link
Member

This is the initial attempt at getting inline documentation in the
project implementation into the sphinx-generated documentation. The way
we achieve this is by doing the following:

  • Add michaeljones/breathe as a submodule, making it simpler to
    generate the documentation with just Sphinx installed on the
    developer machine.
  • Define a Doxyfile configuration which generates HTML and XML
    documentation. The generated XML files are needed by Breathe to
    generate the HTML as part of the Sphinx docs generation process.
  • Update the documentation for the client type. This is a starting
    point showing how the generated docs are in-lined in the RST docs
    via breathe.
  • Wire up the documentation generation in the Sphinx configuration.

To generate the documentation now, we need two things installed on the
machine generating the docs: Sphinx and Doxygen. The steps involved are:

  1. cd cpp-netlib && doxygen
  2. cd libs/network/doc/ && make html

The results should be in libs/network/doc/_build/html, and the
generated HTML for the HTTP Client reference page should include the
doxygen-generated docs.

This is the initial attempt at getting inline documentation in the
project implementation into the sphinx-generated documentation. The way
we achieve this is by doing the following:

  - Add michaeljones/breathe as a submodule, making it simpler to
    generate the documentation with just Sphinx installed on the
    developer machine.
  - Define a Doxyfile configuration which generates HTML and XML
    documentation. The generated XML files are needed by Breathe to
    generate the HTML as part of the Sphinx docs generation process.
  - Update the documentation for the client type. This is a starting
    point showing how the generated docs are in-lined in the RST docs
    via breathe.
  - Wire up the documentation generation in the Sphinx configuration.

To generate the documentation now, we need two things installed on the
machine generating the docs: Sphinx and Doxygen. The steps involved are:

  1. cd cpp-netlib && doxygen
  2. cd libs/network/doc/ && make html

The results should be in libs/network/doc/_build/html, and the
generated HTML for the HTTP Client reference page should include the
doxygen-generated docs.
@deanberris
Copy link
Member Author

Hi @glynos -- are you able to have a look at this?

glynos added a commit that referenced this pull request Jan 12, 2016
Doxygen+Sphinx+Breathe = Inline Documentation
@glynos glynos merged commit e4cb9f3 into cpp-netlib:master Jan 12, 2016
@deanberris
Copy link
Member Author

Thanks @glynos!

@davidvandebunte
Copy link

@deanberris See the issue linked above.

FWIW, it looks like 853385ef4f0c3dd126887750e20d5f7456065998 (the commit you pointed this submodule at) is equivalent to a564b991b5eb2dc220ca29ef21b9c68bdc2f8ac6 in their new history. Perhaps this submodule should be updated to point to this new commit?

davidvandebunte pushed a commit to davidvandebunte/cpp-netlib that referenced this pull request Jun 4, 2018
This project recently had its history rewritten, and the SHA we referred
to no longer exists.

See discussion here:
cpp-netlib#582
deanberris pushed a commit that referenced this pull request Jun 5, 2018
This project recently had its history rewritten, and the SHA we referred
to no longer exists.

See discussion here:
#582
@deanberris
Copy link
Member Author

Thanks @davidvandebunte -- merged your PR. :)

@deanberris deanberris deleted the initial-doxygen branch June 5, 2018 00:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants