forked fromglynos/cpp-netlib
- Notifications
You must be signed in to change notification settings - Fork425
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
+2,611 −34
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
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.
MemberAuthor
deanberris commentedJan 12, 2016
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
MemberAuthor
deanberris commentedJan 13, 2016
Thanks@glynos! |
davidvandebunte commentedJun 4, 2018
@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
MemberAuthor
deanberris commentedJun 5, 2018
Thanks@davidvandebunte -- merged your PR. :) |
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
generate the documentation with just Sphinx installed on the
developer machine.
documentation. The generated XML files are needed by Breathe to
generate the HTML as part of the Sphinx docs generation process.
point showing how the generated docs are in-lined in the RST docs
via breathe.
To generate the documentation now, we need two things installed on the
machine generating the docs: Sphinx and Doxygen. The steps involved are:
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.