Page MenuHomePhabricator

extract markdown fetching from fetch_documentation.sh
ClosedPublic

Authored by PiRK on Sep 21 2020, 14:09.

Details

Summary

It is convenient to run only the last part of fetch_documentation.sh in order to test any changes to the bitcoin-abc markdown files and how they affect the pages on the website. This diff moves the part of fetch_documentation.sh that is related to bitcoin-abc markdown to a separate script fetch_markdown_files.sh. This script takes the path to the local bitcoin-abc git repository as an argument, allowing to extract markdown files from a local developement repository?

Test Plan

Check that make doc still works. Then delete the generated abc_md_docs directory.

Run scripts/fetch_markdown_files.sh /path/to/bitcoin-abc and check that it generated the abc_md_docs directory from the local repository (change something in any md file and confirm the change is present).

Diff Detail

Repository
rABCWEB Bitcoin ABC Website
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

PiRK requested review of this revision.Sep 21 2020, 14:09

add a newline at the end of fetch_documentation.sh

fix a mistake in the test plan (only diff message is affected)

This revision is now accepted and ready to land.Sep 21 2020, 14:33