Allow generating the documentation for DOSDP patterns #1121
Conversation
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
The various DOSDP_* variables (DOSDP_OWL_FILES_X, DOSDP_TERM_FILES_X, and DOSDP_PATTERN_NAMES_X, where 'X' is the name of a DOSDP pipeline) are defined in a inefficient way, as each definition calls the `wildcard` function to get the list of TSV files from the filesystem, which is a costly operation. Here we simplify those definitions by: (1) first defining DOSDP_TSV_FILES_X by calling `wildcard` (no changes); (2) derive DOSDP_PATTERN_NAMES_X directly from DOSDP_TSV_FILES_X; (3) derive DOSDP_OWL_FILES_X directly from DOSDP_PATTERN_NAMES_X; (4) derive DOSDP_TERM_FILES_X directly from DOSDP_PATTERN_NAMES_X. This way, we only query the filesystem once to get the list of the TSV files. All other values can be inferred from that list.
For each pipeline pattern X, we add a `dosdp-docs-X` phony target in the Makefile to automatically generate the documentation for the patterns of that pipeline. This uses the (undocumented ?) `docs` subcommand of DOSDPTools. Generated documentation is written to a new top-level directory called `docs`, in one subdirectory `patterns/X` for each pipeline. closes #1101
matentzn
reviewed
Nov 1, 2024
matentzn
previously approved these changes
Nov 2, 2024
Add a new configuration option `repo_url` to indicate the online location of the public repository. This is intended for repositories that are not hosted on GitHub, where the use of github_org is therefore inappropriate. When generating DOSDP documentation pages, the generated documentation will point to `repo_url` if it is present, then fallback to `https://github.com/github_org/repo` if `github_org` is set.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR adds new targets to the standard Makefile (
dosdp-docs-X, where X is the name of a DOSDP pipeline) to automatically generate the documentations for DOSDP patterns.This is inspired by CL’s custom
pattern_docstarget, except there here are using DOSDPTools and its (seemingly undocumented)docssubcommand rather than DOSDP, because DOSDP seems to crash on way too many patterns.