Skip to content
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

Add dev docs generation to Jenkins: #2343

Closed
wants to merge 2 commits into from
Closed

Add dev docs generation to Jenkins: #2343

wants to merge 2 commits into from

Conversation

mellery451
Copy link
Contributor

Switch to pure doxygen HTML for developer docs. Remove docca/boostbook
system. Convert consensus document to markdown. Add existing markdown
files to doxygen input set.

This is how it looks when built/stored by jenkins:

https://ci.ops.ripple.com/view/rippled-dev/job/mellery-rippled/job/mellery-doxs/Doxygen/

@ripplelabs-jenkins
Copy link
Collaborator

ripplelabs-jenkins commented Jan 20, 2018

Jenkins Build Summary

Built from this commit

Built at 20180125 - 17:50:08

Test Results

Build Type Result Status
docs no test results, t: 1s PASS ✅
coverage 985 cases, 0 failed, t: 628s PASS ✅
clang.debug.unity 985 cases, 0 failed, t: 395s PASS ✅
clang.debug.nounity 983 cases, 0 failed, t: 337s PASS ✅
gcc.debug.unity 985 cases, 0 failed, t: 439s PASS ✅
gcc.debug.nounity 983 cases, 0 failed, t: 327s PASS ✅
clang.release.unity 984 cases, 0 failed, t: 480s PASS ✅
gcc.release.unity 984 cases, 0 failed, t: 497s PASS ✅
gcc.debug.unity -Dstatic=true 985 cases, 0 failed, t: 437s PASS ✅

Copy link
Collaborator

@bachase bachase left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I successfully compiled docs on Windows using the command line, docker and cmake.

I noticed some markdown files are referencing images that are not in the compiled directory ( README.md, consensus.md).

Otherwise looks good!

@mellery451
Copy link
Contributor Author

@bachase I shuffled a few more files around and I believe that images are working now in generated docs (doxygen) and in github rendering. Please let me know if you agree.

@bachase
Copy link
Collaborator

bachase commented Jan 23, 2018

Cleanup looks good. I found one last image issue in the consensus simulation framework README if you want to grab it bachase@81659e4.

Copy link
Collaborator

@bachase bachase left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

Switch to pure doxygen HTML for developer docs. Remove docca/boostbook
system. Convert consensus document to markdown. Add existing markdown
files to doxygen input set. Fix some image paths and scale images for
use with MD links. Rename/cleanup some files for consistency.
@bachase
Copy link
Collaborator

bachase commented Jan 25, 2018

A little late, but I believe you can also remove the Jamroot file in the top-level directory.

@mellery451
Copy link
Contributor Author

closing this because I'm folding into a cumulative jenkins change (forthcoming)

@mellery451 mellery451 closed this Jan 31, 2018
@mellery451 mellery451 deleted the mellery-doxs branch February 1, 2018 18:15
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.

5 participants