Differential D7206

[RPC Docs] Use .html instead of .md extension for generated RPC docs
ClosedPublic
Actions

Authored by jasonbcox on Aug 17 2020, 21:53.

Tags

None

Subscribers

None

Details

Reviewers

Group Reviewers

Restricted Project

Commits

rABCc755af9ca53e: [RPC Docs] Use .html instead of .md extension for generated RPC docs

Summary

This is a partial revert of D7052. Jekyll pre-renders all markdown to HTML
before rendering page layouts, so there is no way to access the raw file contents
without additional workarounds. Although this extension is wrong given the file contents,
this is clearly the path of least resistance for rendering these files without HTML
tags.

Test Plan

build-configurations.py build-docs
cp -r abc-ci-builds/build-docs/rpc/docs/en/0.22.0 ~/projects/bitcoin-abc-website/_doc/
pushd ~/projects/bitcoin-abc
make serve

Navigate to http://localhost:4000/doc/0.22.0/rpc/blockchain/getblockchaininfo/ and verify
no HTML tags are present in the RPC doc content.

Diff Detail

Repository

rABC Bitcoin ABC

Branch

revert-md

Lint

Lint Passed

Unit

No Test Coverage

Build Status

Buildable 12407
Build 24988: Build Diff	build-clang-tidy · build-clang-10 · build-diff · build-without-wallet
Build 24987: arc lint + arc unit

Event Timeline

jasonbcox created this revision.Aug 17 2020, 21:53

Herald added a reviewer: Restricted Project. · View Herald TranscriptAug 17 2020, 21:53

jasonbcox requested review of this revision.Aug 17 2020, 21:53

Harbormaster completed remote builds in B12407: Diff 22928.Aug 17 2020, 22:08

deadalnix accepted this revision.Aug 18 2020, 09:55

This revision is now accepted and ready to land.Aug 18 2020, 09:55

Closed by commit rABCc755af9ca53e: [RPC Docs] Use .html instead of .md extension for generated RPC docs (authored by jasonbcox). · Explain WhyAug 18 2020, 15:34

This revision was automatically updated to reflect the committed changes.

jasonbcox added a commit: rABCc755af9ca53e: [RPC Docs] Use .html instead of .md extension for generated RPC docs.

jasonbcox mentioned this in D7214: Fix existing doc format.Aug 18 2020, 15:55

jasonbcox mentioned this in D7215: Add 0.22.0 RPC docs.Aug 18 2020, 15:58

jasonbcox mentioned this in rABCWEB66a0573ae331: Fix existing doc format.Aug 18 2020, 16:27

jasonbcox mentioned this in rABCWEBeaba1a47bac1: Add 0.22.0 RPC docs.

Revision Contents
Changeset List

Path

Size

doc/

rpc/

2 lines

Diff 22928

doc/rpc/generate.go

Loading...