Skip to content

Commit

Permalink
chore: Fix documentation generation job: (XRPLF#5091)
Browse files Browse the repository at this point in the history
* Add "doxygen" to list of supported branches to allow for testing and
  development.
* Add titles / H1 to some .md files that don't have them.
  • Loading branch information
ximinez authored Aug 15, 2024
1 parent 93d8baf commit d9bd75e
Show file tree
Hide file tree
Showing 7 changed files with 26 additions and 16 deletions.
1 change: 1 addition & 0 deletions .github/workflows/doxygen.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ on:
push:
branches:
- develop
- doxygen
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
Expand Down
2 changes: 2 additions & 0 deletions bin/ci/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Continuous Integration (CI) Scripts

In this directory are two scripts, `build.sh` and `test.sh` used for building
and testing rippled.

Expand Down
18 changes: 10 additions & 8 deletions cmake/RippledDocs.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,17 @@ set(doxyfile "${CMAKE_CURRENT_SOURCE_DIR}/docs/Doxyfile")

file(GLOB_RECURSE doxygen_input
docs/*.md
src/ripple/*.h
src/ripple/*.cpp
src/ripple/*.md
src/test/*.h
src/test/*.md)
include/*.h
include/*.cpp
include/*.md
src/*.h
src/*.cpp
src/*.md
Builds/*.md
*.md)
list(APPEND doxygen_input
README.md
RELEASENOTES.md
src/README.md)
external/README.md
)
set(dependencies "${doxygen_input}" "${doxyfile}")

function(verbose_find_path variable name)
Expand Down
15 changes: 7 additions & 8 deletions docs/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -103,18 +103,17 @@ WARN_LOGFILE =
# Configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = \
docs \
src/ripple \
src/test \
src/README.md \
README.md \
RELEASENOTES.md \
. \


INPUT_ENCODING = UTF-8
FILE_PATTERNS = *.h *.cpp *.md
RECURSIVE = YES
EXCLUDE =
EXCLUDE = \
.github \
external/ed25519-donna \
external/secp256k1 \

EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS =
EXCLUDE_SYMBOLS =
Expand All @@ -130,7 +129,7 @@ INPUT_FILTER =
FILTER_PATTERNS =
FILTER_SOURCE_FILES = NO
FILTER_SOURCE_PATTERNS =
USE_MDFILE_AS_MAINPAGE = src/README.md
USE_MDFILE_AS_MAINPAGE = ./README.md

#---------------------------------------------------------------------------
# Configuration options related to source browsing
Expand Down
2 changes: 2 additions & 0 deletions external/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# External Conan recipes

The subdirectories in this directory contain either copies or Conan recipes
of external libraries used by rippled.
The Conan recipes include patches we have not yet pushed upstream.
Expand Down
2 changes: 2 additions & 0 deletions include/xrpl/proto/org/xrpl/rpc/v1/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Protocol buffer definitions for gRPC

This folder contains the protocol buffer definitions used by the rippled gRPC API.
The gRPC API attempts to mimic the JSON/Websocket API as much as possible.
As of April 2020, the gRPC API supports a subset of the full rippled API:
Expand Down
2 changes: 2 additions & 0 deletions src/xrpld/app/reporting/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Reporting mode

Reporting mode is a special operating mode of rippled, designed to handle RPCs
for validated data. A server running in reporting mode does not connect to the
p2p network, but rather extracts validated data from a node that is connected
Expand Down

0 comments on commit d9bd75e

Please sign in to comment.