Fix up XRP-API docs for XRPL.org display

This commit is contained in:
mDuo13
2020-05-21 14:13:41 -07:00
parent 94cacb0d72
commit 9560737e0d
2 changed files with 19 additions and 0 deletions

View File

@@ -69,6 +69,8 @@ targets:
github_forkurl: https://github.com/ripple/xrpl-dev-portal
github_branch: master
locale_file: locale/en/LC_MESSAGES/messages.mo
link_subs:
"./src/api-v3/paths/preparations/payments.ts": "https://github.com/xpring-eng/xrp-api/blob/master/src/api-v3/paths/preparations/payments.ts"
- name: ja
lang: ja
@@ -169,6 +171,8 @@ targets:
github_forkurl: https://github.com/ripple/xrpl-dev-portal
github_branch: master
no_cover: true
link_subs:
"./src/api-v3/paths/preparations/payments.ts": "https://github.com/xpring-eng/xrp-api/blob/master/src/api-v3/paths/preparations/payments.ts"
# Data API target for porting changes to the README in the upstream repo
# Intended for use in markdown (--md) mode.
@@ -5555,6 +5559,8 @@ pages:
funnel: Docs
doc_type: References
supercategory: XRP-API
filters:
- xrpapi_readme
targets:
- en
- ja

View File

@@ -0,0 +1,13 @@
def filter_markdown(md, **kwargs):
"""
Remove the link to the dev portal from the readme and replace it with
a link to the repo (since we're in the dev portal already).
"""
REMOVE = """## [➡️ XRP API Reference Documentation](https://xrpl.org/xrp-api.html)
See the full reference documentation on the XRP Ledger Dev Portal."""
REPLACEMENT = """[[Source]](https://github.com/xpring-eng/xrp-api "Source")"""
return md.replace(REMOVE, REPLACEMENT)