Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
glynos merged 1 commit intocpp-netlib:masterfromdeanberris:initial-doxygen
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 theproject implementation into the sphinx-generated documentation. The waywe 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 themachine generating the docs: Sphinx and Doxygen. The steps involved are:  1. cd cpp-netlib && doxygen  2. cd libs/network/doc/ && make htmlThe results should be in libs/network/doc/_build/html, and thegenerated HTML for the HTTP Client reference page should include thedoxygen-generated docs.
@deanberris
Copy link
MemberAuthor

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

glynos added a commit that referenced this pull requestJan 12, 2016
Doxygen+Sphinx+Breathe = Inline Documentation
@glynosglynos merged commite4cb9f3 intocpp-netlib:masterJan 12, 2016
@deanberris
Copy link
MemberAuthor

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 requestJun 4, 2018
This project recently had its history rewritten, and the SHA we referredto no longer exists.See discussion here:cpp-netlib#582
deanberris pushed a commit that referenced this pull requestJun 5, 2018
This project recently had its history rewritten, and the SHA we referredto no longer exists.See discussion here:#582
@deanberris
Copy link
MemberAuthor

Thanks@davidvandebunte -- merged your PR. :)

@deanberrisdeanberris deleted the initial-doxygen branchJune 5, 2018 00:45
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers
No reviews
Assignees

@glynosglynos

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

3 participants
@deanberris@davidvandebunte@glynos

[8]ページ先頭

©2009-2025 Movatter.jp