-
Notifications
You must be signed in to change notification settings - Fork 35
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 ecTrans documentation site #121
Open
samhatfield
wants to merge
23
commits into
develop
Choose a base branch
from
samhatfield/docs
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
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
https://sites.ecmwf.int/docs/ectrans/ now public. |
I have now switched from mkdocs to Ford.
samhatfield
force-pushed
the
samhatfield/docs
branch
from
August 12, 2024 13:33
241c7e9
to
5252b3c
Compare
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.
Addresses #113.
This PR will add the capability to build and publish to sites.ecmwf.int/docs/ectrans a documentation site.
The site is built primarily with FORD. This generates a hyperlinked code directory for src/trans. In addition it takes some hand-written Markdown files to produce a "User Guide" section.
There is an API section in the User Guide which is generated automatically by extracting a docblock from each of the files in src/trans/include/ectrans. This docblock is demarcated with
begin_doc_block
andend_doc_block
tokens and should be written in Markdown. It will be copied verbatim into the api.md file (with Fortran comment markers stripped out. This is done by the build.sh script. Whether we actually need this is up for debate. I thought it would be useful so a first-time user doesn't need to wade into the code directory to find the usage for e.g.SETUP_TRANS
. But with better commenting, the specific page forSETUP_TRANS
has the potential to be just as useful. Perhaps the API page should just have a list of links to the corresponding pages for each external subroutine.A subsite is also generated for transi using Doxygen.
TODO:
begin/end_docblock
I would say once the site is active and we have merged rgo-develop (and rebased this on top) we can merge this PR too, and gradually flesh it out.