diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml index 10a1465192a..e2265d1b83b 100644 --- a/.github/workflows/doxygen.yml +++ b/.github/workflows/doxygen.yml @@ -4,6 +4,7 @@ on: push: branches: - develop + - doxygen concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true diff --git a/bin/ci/README.md b/bin/ci/README.md index 36d4fc1d310..32ae24b3a20 100644 --- a/bin/ci/README.md +++ b/bin/ci/README.md @@ -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. diff --git a/cmake/RippledDocs.cmake b/cmake/RippledDocs.cmake index a9b8b283bf0..d93bc119c0d 100644 --- a/cmake/RippledDocs.cmake +++ b/cmake/RippledDocs.cmake @@ -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) diff --git a/docs/Doxyfile b/docs/Doxyfile index 48a0b5d1e1a..750ae0fb649 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -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 = @@ -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 diff --git a/external/README.md b/external/README.md index f45f80965a5..25ae577ba58 100644 --- a/external/README.md +++ b/external/README.md @@ -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. diff --git a/include/xrpl/proto/org/xrpl/rpc/v1/README.md b/include/xrpl/proto/org/xrpl/rpc/v1/README.md index c5000104257..9268439847d 100644 --- a/include/xrpl/proto/org/xrpl/rpc/v1/README.md +++ b/include/xrpl/proto/org/xrpl/rpc/v1/README.md @@ -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: diff --git a/src/xrpld/app/reporting/README.md b/src/xrpld/app/reporting/README.md index 745cbb633a9..f55b2d8d60d 100644 --- a/src/xrpld/app/reporting/README.md +++ b/src/xrpld/app/reporting/README.md @@ -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