Add GitHub workflow to publish docs on GitHub #3302
There are no files selected for viewing
This file contains 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 |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| name: Build and publish Doxygen documentation | ||
| on: | ||
| push: | ||
| branches: | ||
| - develop | ||
|
|
||
| jobs: | ||
| job: | ||
| runs-on: ubuntu-18.04 | ||
| steps: | ||
| - name: checkout | ||
| uses: actions/checkout@v2 | ||
| - name: set OUTPUT_DIRECTORY | ||
| run: echo 'OUTPUT_DIRECTORY = html' >> docs/Doxyfile | ||
| - name: build | ||
| uses: mattnotmitt/doxygen-action@v1 | ||
| with: | ||
| doxyfile-path: 'docs/Doxyfile' | ||
| - name: publish | ||
| uses: peaceiris/actions-gh-pages@v3 | ||
| with: | ||
| github_token: ${{ secrets.GITHUB_TOKEN }} | ||
| publish_dir: ./html | ||
This file contains 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 file contains 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 file contains 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 file contains 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 |
|---|---|---|
|
|
@@ -4,10 +4,10 @@ | |
| DOXYFILE_ENCODING = UTF-8 | ||
| PROJECT_NAME = "rippled" | ||
| PROJECT_NUMBER = | ||
| PROJECT_BRIEF = | ||
| PROJECT_LOGO = | ||
| PROJECT_LOGO = | ||
| OUTPUT_DIRECTORY = $(DOXYGEN_OUTPUT_DIRECTORY) | ||
| CREATE_SUBDIRS = NO | ||
| ALLOW_UNICODE_NAMES = NO | ||
| OUTPUT_LANGUAGE = English | ||
|
|
@@ -17,7 +17,7 @@ ABBREVIATE_BRIEF = | |
| ALWAYS_DETAILED_SEC = NO | ||
| INLINE_INHERITED_MEMB = YES | ||
| FULL_PATH_NAMES = NO | ||
| STRIP_FROM_PATH = src/ | ||
| STRIP_FROM_INC_PATH = | ||
| SHORT_NAMES = NO | ||
| JAVADOC_AUTOBRIEF = YES | ||
|
|
@@ -27,15 +27,14 @@ INHERIT_DOCS = YES | |
| SEPARATE_MEMBER_PAGES = NO | ||
| TAB_SIZE = 4 | ||
| ALIASES = | ||
| OPTIMIZE_OUTPUT_FOR_C = NO | ||
| OPTIMIZE_OUTPUT_JAVA = NO | ||
| OPTIMIZE_FOR_FORTRAN = NO | ||
| OPTIMIZE_OUTPUT_VHDL = NO | ||
| EXTENSION_MAPPING = | ||
| MARKDOWN_SUPPORT = YES | ||
| AUTOLINK_SUPPORT = YES | ||
| BUILTIN_STL_SUPPORT = YES | ||
| CPP_CLI_SUPPORT = NO | ||
| SIP_SUPPORT = NO | ||
| IDL_PROPERTY_SUPPORT = YES | ||
|
|
@@ -83,7 +82,7 @@ ENABLED_SECTIONS = | |
| MAX_INITIALIZER_LINES = 30 | ||
| SHOW_USED_FILES = NO | ||
| SHOW_FILES = NO | ||
| SHOW_NAMESPACES = YES | ||
| FILE_VERSION_FILTER = | ||
| LAYOUT_FILE = | ||
| CITE_BIB_FILES = | ||
|
|
@@ -104,71 +103,17 @@ WARN_LOGFILE = | |
| # Configuration options related to the input files | ||
| #--------------------------------------------------------------------------- | ||
| INPUT = \ | ||
|
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. |
||
| docs \ | ||
| src/ripple \ | ||
| src/test \ | ||
| src/README.md \ | ||
| README.md \ | ||
| RELEASENOTES.md \ | ||
|
|
||
|
|
||
| INPUT_ENCODING = UTF-8 | ||
| FILE_PATTERNS = *.h *.cpp *.md | ||
ximinez marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| RECURSIVE = YES | ||
| EXCLUDE = | ||
| EXCLUDE_SYMLINKS = NO | ||
| EXCLUDE_PATTERNS = | ||
|
|
@@ -177,20 +122,20 @@ EXAMPLE_PATH = | |
| EXAMPLE_PATTERNS = | ||
| EXAMPLE_RECURSIVE = NO | ||
| IMAGE_PATH = \ | ||
| docs/images/ \ | ||
| docs/images/consensus/ \ | ||
| src/test/csf/ \ | ||
|
|
||
| INPUT_FILTER = | ||
| FILTER_PATTERNS = | ||
| FILTER_SOURCE_FILES = NO | ||
| FILTER_SOURCE_PATTERNS = | ||
| USE_MDFILE_AS_MAINPAGE = src/README.md | ||
|
|
||
| #--------------------------------------------------------------------------- | ||
| # Configuration options related to source browsing | ||
| #--------------------------------------------------------------------------- | ||
| SOURCE_BROWSER = YES | ||
| INLINE_SOURCES = NO | ||
| STRIP_CODE_COMMENTS = YES | ||
| REFERENCED_BY_RELATION = NO | ||
|
|
@@ -213,7 +158,7 @@ IGNORE_PREFIX = | |
| # Configuration options related to the HTML output | ||
| #--------------------------------------------------------------------------- | ||
| GENERATE_HTML = YES | ||
| HTML_OUTPUT = html | ||
| HTML_FILE_EXTENSION = .html | ||
| HTML_HEADER = | ||
| HTML_FOOTER = | ||
|
|
@@ -273,7 +218,7 @@ EXTRA_SEARCH_MAPPINGS = | |
| #--------------------------------------------------------------------------- | ||
| GENERATE_LATEX = NO | ||
| LATEX_OUTPUT = latex | ||
| LATEX_CMD_NAME = | ||
| MAKEINDEX_CMD_NAME = makeindex | ||
| COMPACT_LATEX = NO | ||
| PAPER_TYPE = a4 | ||
|
|
@@ -314,7 +259,7 @@ MAN_LINKS = NO | |
| # Configuration options related to the XML output | ||
| #--------------------------------------------------------------------------- | ||
| GENERATE_XML = NO | ||
| XML_OUTPUT = xml | ||
| XML_PROGRAMLISTING = YES | ||
|
|
||
| #--------------------------------------------------------------------------- | ||
|
|
@@ -340,7 +285,7 @@ ENABLE_PREPROCESSING = YES | |
| MACRO_EXPANSION = YES | ||
| EXPAND_ONLY_PREDEF = YES | ||
| SEARCH_INCLUDES = YES | ||
| INCLUDE_PATH = $(DOXYGEN_INCLUDE_PATH) | ||
| INCLUDE_FILE_PATTERNS = | ||
| PREDEFINED = DOXYGEN \ | ||
| GENERATING_DOCS \ | ||
|
|
@@ -353,21 +298,20 @@ SKIP_FUNCTION_MACROS = YES | |
| #--------------------------------------------------------------------------- | ||
| # Configuration options related to external references | ||
| #--------------------------------------------------------------------------- | ||
| TAGFILES = $(DOXYGEN_TAGFILES) | ||
| GENERATE_TAGFILE = | ||
| ALLEXTERNALS = NO | ||
| EXTERNAL_GROUPS = YES | ||
| EXTERNAL_PAGES = YES | ||
|
|
||
| #--------------------------------------------------------------------------- | ||
| # Configuration options related to the dot tool | ||
| #--------------------------------------------------------------------------- | ||
| CLASS_DIAGRAMS = NO | ||
| DIA_PATH = | ||
| HIDE_UNDOC_RELATIONS = YES | ||
| HAVE_DOT = YES | ||
| # DOT_NUM_THREADS = 0 means 1 for every processor. | ||
| DOT_NUM_THREADS = 0 | ||
| DOT_FONTNAME = Helvetica | ||
| DOT_FONTSIZE = 10 | ||
|
|
@@ -386,11 +330,11 @@ GRAPHICAL_HIERARCHY = YES | |
| DIRECTORY_GRAPH = YES | ||
| DOT_IMAGE_FORMAT = png | ||
| INTERACTIVE_SVG = NO | ||
| DOT_PATH = $(DOXYGEN_DOT_PATH) | ||
| DOTFILE_DIRS = | ||
| MSCFILE_DIRS = | ||
| DIAFILE_DIRS = | ||
| PLANTUML_JAR_PATH = $(DOXYGEN_PLANTUML_JAR_PATH) | ||
| PLANTUML_INCLUDE_PATH = | ||
| DOT_GRAPH_MAX_NODES = 50 | ||
| MAX_DOT_GRAPH_DEPTH = 0 | ||
|
|
||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why not ubuntu-latest?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just to pin the version so we can reliably build. We can control when we update this way.