Giter VIP home page Giter VIP logo

hh-apidoc's Introduction

hh-apidoc

Continuous Integration

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

  1. Install hhvm
  2. Install composer
  3. Move composer.phar to your desired location. Many people put this in their home directory or a global bin directory.
  4. Clone this repo
  5. cd path/to/cloned/hh-apidoc
  6. hhvm path/to/composer.phar install
  7. 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:

  1. 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.
  2. cd /tmp/docs
  3. See generated .html files. You can open index.html in your favorite browser to see the generated documentation.

License

hh-apidoc is MIT licensed, as found in the LICENSE file.

hh-apidoc's People

Contributors

alexeyt avatar atry avatar azjezz avatar fredemmott avatar github-actions[bot] avatar jjergus avatar joelmarcey avatar lexidor avatar wilfred avatar yurybandarchuk16 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

hh-apidoc's Issues

Unable to generate index document. [StackOverflowException]

Parsing...
Generating documentation...
Creating index document...

Fatal error: Stack overflow in /opt/lampp/htdocs/hh-apidoc/vendor/facebook/fbmarkdown/src/unparsed-blocks/Lines.php on line 105

hhvm --version
HipHop VM 4.8.0 (rel)
Compiler: 1559583155_055573146
Repo schema: bbe84ac83be4cac392df68fc2c6cc8b7c6516bfd

Will make an issue in facebook/fbmarkdown that refers to this issue.

If there is a common namespace, strip it.

For example, the documentation for this project frequently uses both Facebook\DefinitionFinder and Facebook\HHAPIDoc. It would be briefer and clearer on these pages if the Facebook\ was stripped, rather than the Facebook\HHAPIDoc

Improve `Facebook\HHAPIDoc\MarkdownExt\AutoLinkifyFilter`

This filters code spans to automatically turn types into links - for example:

`MyClass` already becomes a link to "MyClass"'s documentation page
`MyClass<MyOtherClass>` should link to both `MyClass` and `MyOtherClass`'s documentation pages
`"foo": MyClass` should link to `MyClass`'s documentation page

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.