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
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
Doxygen+Sphinx+Breathe = Inline Documentation
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.
- Loading branch information
Uh oh!
There was an error while loading.Please reload this page.
commit86146c3f4fd8f75dbf68998b21265d0140d3de9a
There are no files selected for viewing
2 changes: 2 additions & 0 deletions.gitignore
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -11,3 +11,5 @@ libs/mime/test/mime-roundtrip | ||
_build | ||
/.project | ||
build/ | ||
libs/network/doc/doxygen/ | ||
.DS_Store |
3 changes: 3 additions & 0 deletions.gitmodules
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
2,384 changes: 2,384 additions & 0 deletionsDoxyfile
Large diffs are not rendered by default.
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
39 changes: 26 additions & 13 deletionsboost/network/protocol/http/client.hpp
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
179 changes: 161 additions & 18 deletionsboost/network/protocol/http/client/facade.hpp
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
3 changes: 2 additions & 1 deletionboost/network/protocol/http/client/options.hpp
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
2 changes: 1 addition & 1 deletionboost/network/protocol/http/client/pimpl.hpp
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
1 change: 1 addition & 0 deletionslibs/network/doc/_ext/breathe
14 changes: 13 additions & 1 deletionlibs/network/doc/conf.py
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
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
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.