facebook / hh-apidoc
Installs: 13 248
Dependents: 0
Suggesters: 0
Security: 0
Stars: 10
Watchers: 14
Forks: 7
Open Issues: 9
Language:Hack
Requires
- hhvm: ^4.102
- facebook/definition-finder: ^2.13.0
- facebook/fbmarkdown: ^1.6.5
- facebook/hh-clilib: ^2.1.0
- hhvm/hhast: ^4.80
- hhvm/hsl: ^4.0
- hhvm/hsl-experimental: ^4.53
- hhvm/hsl-io: ^0.2.1|^0.3
Requires (Dev)
- hhvm/hhvm-autoload: ^2.0|^3.0
README
An API documentation generator for Hack files. The generator works on files that start with <?hh
.
Example
HHAPIDoc generates its own API reference documentation.
Project status
This is derived from docs.hhvm.com's documentation generator, and has been in use there for several months.
As a standalone project, it is immature, and an early preview; work is needed on output format (prettiness), usability, and functionality. See the issues to get started. We welcome contributions.
Installing hh-apidoc
- Install hhvm
- Install composer
- Move
composer.phar
to your desired location. Many people put this in their home directory or a globalbin
directory. - Clone this repo
cd path/to/cloned/hh-apidoc
hhvm path/to/composer.phar install
- Verify installation via
hhvm bin/hh-apidoc --help
. You should see usage instructions.
Testing hh-apidoc
Running hh-apidoc
against itself is a good way to test the generator:
hhvm bin/hh-apidoc -o /tmp/docs ./src
The-o
is where to output the resulting files (it is important to note that the path given to-o
must currently be an existing path)..
means use the current directory as the source.cd /tmp/docs
- See generated
.html
files. You can openindex.html
in your favorite browser to see the generated documentation.
License
hh-apidoc is MIT licensed, as found in the LICENSE file.