Page MenuHomePhabricator

Add autoindexing for /doc route
ClosedPublic

Authored by jasonbcox on Tue, Jul 28, 01:00.

Details

Reviewers
deadalnix
Group Reviewers
Restricted Project
Commits
rABCWEBb059f4bf972f: Add autoindexing for /doc route
Summary

This is a temporary measure so that the RPC docs are easy to navigate until
proper indexing pages are created. This allows us to easily test and deploy RPC
documentation on various routes under /doc/ without needing to update configs.
A simple redeploy will suffice.

Test Plan
cp ~/projects/bitcoin-abc/abc-ci-builds/build-docs/doc .
make container
make run

Visit http://127.0.0.1:8080/doc/ in a browser and navigate.

Diff Detail

Repository
rABCWEB Bitcoin ABC Website
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

jasonbcox created this revision.Tue, Jul 28, 01:00
Herald added a reviewer: Restricted Project. · View Herald TranscriptTue, Jul 28, 01:00
jasonbcox requested review of this revision.Tue, Jul 28, 01:00
Fabien added a subscriber: Fabien.Tue, Jul 28, 09:38

I don't quite get it, since D7052 updated the generated extension there is no html anymore in the RPC docs ?

deadalnix accepted this revision.Tue, Jul 28, 12:09
This revision is now accepted and ready to land.Tue, Jul 28, 12:09

I don't quite get it, since D7052 updated the generated extension there is no html anymore in the RPC docs ?

bitcoinabc.org is a Jekyll website and able to compile markdown to HTML. We build the website with the RPC doc markdown files and end up with HTML pages that use the same styling as the rest of the site.

This revision was automatically updated to reflect the committed changes.