https://github.com/frqnck/apix-docs

The APIx documentation for https://github.com/frqnck/apix/
https://github.com/frqnck/apix-docs

Last synced: about 18 hours ago
JSON representation

The APIx documentation for https://github.com/frqnck/apix/

• Host: GitHub
• URL: https://github.com/frqnck/apix-docs
• Owner: frqnck
• License: other
• Created: 2014-10-14T13:07:59.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2014-10-27T16:16:17.000Z (about 10 years ago)
• Last Synced: 2024-10-12T09:47:19.212Z (3 months ago)
• Language: Python
• Size: 203 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
APIx Manual & Documentation

===========================

The APIx Manual and Documentation use [reStructuredText](http://docutils.sourceforge.net/rst.html) format/parser and the [Sphinx](http://sphinx-doc.org) tool.

There are two distinct documentation trees contained within this directory:

Official Manual

---------------

* [Introduction](source/introduction.rst)

* [Quick Start](source/quickstart.rst>)

* [Configuration](source/config.rst>)

* [Example Project](source/example.rst>)

* [Plugins](source/plugins/index.rst>)

This manual is also rendered online on: Officila APIx Manual (http://apix.readthedocs.org)

API Documentation

-----------------

This is extracted from the APIx source code and comments using `Javadoc `_ and `PHPDoc `_ formats.

Viewable at: [index](source/apix/index.rst>)

Installation

------------

To install Sphinx and dependencies run ``pip install sphinxcontrib-phpdomain`` then run ``make html``.

Contributing

------------

See [Contributing](CONTRIBUTING.md).

License

-------

APIx is licensed under the New BSD license -- see the [LICENSE](LICENSE) for the full license details.