docs: added details on building docs
This commit is contained in:
parent
4f257279ab
commit
bfe7b6d80f
@ -26,10 +26,9 @@ _subsection: Documentation @<about-contrib-docs>
|
|||||||
The documentation is an area which can always benefit from extra
|
The documentation is an area which can always benefit from extra
|
||||||
eyes, extra knowledge and extra examples.
|
eyes, extra knowledge and extra examples.
|
||||||
|
|
||||||
Contributing to the documentation is welcome
|
Contributing to the documentation is welcome, but when making
|
||||||
|
changes to documentation, please ensure that all changes are
|
||||||
When making changes to documentation, please ensure that all
|
made **only** to:
|
||||||
changes are made **only** to:
|
|
||||||
|
|
||||||
- Updating ``/docs.wrm/*\*.wrm``
|
- Updating ``/docs.wrm/*\*.wrm``
|
||||||
- Adding links: ``/docs.wrm/links/*.txt``
|
- Adding links: ``/docs.wrm/links/*.txt``
|
||||||
@ -44,6 +43,37 @@ preferred.
|
|||||||
|
|
||||||
All changes should be in the Flatworm Markdown Dialect.
|
All changes should be in the Flatworm Markdown Dialect.
|
||||||
|
|
||||||
|
_heading: Building the Documentation
|
||||||
|
|
||||||
|
Currently, the documentation is built using an experimental v2 of the
|
||||||
|
Flatworm documentation system, a system originally specifically made
|
||||||
|
to maintain the Ethers documentation.
|
||||||
|
|
||||||
|
The new ``tsdocs`` branch has the ability to parse ``jsdocs`` from
|
||||||
|
from TypeScript source files to create an API reference.
|
||||||
|
|
||||||
|
_code: Building with the v2 Flatworm @lang<shell>
|
||||||
|
|
||||||
|
# Clone the repo
|
||||||
|
/home/ricmoo> git clone https://github.com/ricmoo/flatworm.git
|
||||||
|
/home/ricmoo> cd flatworm
|
||||||
|
|
||||||
|
# Check out the tsdocs branch
|
||||||
|
/home/ricmoo/flatworm> git checkout tsdocs
|
||||||
|
|
||||||
|
# Install the necessary dependencies
|
||||||
|
/home/ricmoo/flatworm> npm install
|
||||||
|
|
||||||
|
# Ready to build the docs; output to a folder ./output/
|
||||||
|
/home/ricmoo/flatworm> node lib/test-api-index PATH_TO_WRM_ROOT
|
||||||
|
|
||||||
|
Eventually the code for the v2 branch will be cleaned up, and it
|
||||||
|
will be much easier to include as a ``devDependency`` for Ethers.
|
||||||
|
|
||||||
|
In the meantime, expect new changes to be made frequently to the
|
||||||
|
``tsdocs`` branch, so for stability you may wish to checkout a
|
||||||
|
specific hash.
|
||||||
|
|
||||||
|
|
||||||
_subsection: Fixing Bugs @<about-contrib-bugs>
|
_subsection: Fixing Bugs @<about-contrib-bugs>
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user