Add GitHub workflow to publish docs on GitHub #3302
Conversation
| endif () | ||
|
|
||
| # https://en.cppreference.com/w/Cppreference:Archives | ||
| # https://stackoverflow.com/questions/60822559/how-to-move-a-file-download-from-configure-step-to-build-step |
| ../src/ripple/json/README.md \ | ||
| ../src/ripple/json/TODO.md \ | ||
| ../src/ripple/resource/README.md \ | ||
| ../src/ripple/rpc/README.md \ |
There was a problem hiding this comment.
Are these READMEs still included in the documentation? I can't seem to find them at https://thejohnfreeman.github.io/rippled/. For instance, where do I find src/ripple/rpc/README.md?
There was a problem hiding this comment.
They're all under Related Pages: https://thejohnfreeman.github.io/rippled/pages.html
To find a given document, you need to know its title. I'd like to go through and re-title them all to make them easier to find in the Related Pages list. src/ripple/rpc/README.md is at https://thejohnfreeman.github.io/rippled/md_ripple_rpc_README.html
There was a problem hiding this comment.
@thejohnfreeman Left one comment worth a response. The github action looks good. To be honest, I am not all that familiar with a lot of the things that are going on in this pull request: doxygen itself, cmake and doxygen integration, and docker. So a "looks good to me" from me shouldn't carry too much weight.
Codecov Report
@@ Coverage Diff @@
## develop #3302 +/- ##
===========================================
- Coverage 70.61% 70.60% -0.02%
===========================================
Files 676 676
Lines 54339 54339
===========================================
- Hits 38374 38368 -6
- Misses 15965 15971 +6
Continue to review full report at Codecov.
|
|
|
||
| jobs: | ||
| job: | ||
| runs-on: ubuntu-18.04 |
There was a problem hiding this comment.
Just to pin the version so we can reliably build. We can control when we update this way.
carlhua
added
the
Ready to merge
This will update https://ripple.github.io/rippled automatically any time we push to the
developbranch. We can always push to thegh-pagesbranch manually to override it.You can see an example of the current output at https://thejohnfreeman.github.io/rippled.
I experimented with Read The Docs before this. RTD supports browsing multiple versions of documentation via its Sphinx theme, but the HTML output of Doxygen is completely unaware of this theme. Even if we were ok with supporting just a single version, getting Sphinx to use the raw HTML output of Doxygen requires a custom builder, but RTD only lets us choose one of the three built-in builders (
html,dirhtml, andsinglehtml).