X-Git-Url: http://www.project-moonshot.org/gitweb/?a=blobdiff_plain;f=README.rst;h=27706dd5a7d13b5d9422254a7586edd8061f5db9;hb=978a47e2c52cca0999bbc8eb6d35674d4931ed5c;hp=66243ebdd8f3475718ec215f4365b19f751f4ee2;hpb=251722d499cc2ec0962580f6cf60ed0acdc5330e;p=jansson.git diff --git a/README.rst b/README.rst index 66243eb..27706dd 100644 --- a/README.rst +++ b/README.rst @@ -6,14 +6,14 @@ data. Its main features and design principles are: - Simple and intuitive API and data model -- Good documentation +- Comprehensive documentation + +- No dependencies on other libraries - Full Unicode support (UTF-8) - Extensive test suite -- No dependencies on other libraries - Jansson is licensed under the `MIT license`_; see LICENSE in the source distribution for details. @@ -36,8 +36,6 @@ To run the test suite, invoke:: $ make check -Python_ is required to run the tests. - Documentation ------------- @@ -49,15 +47,13 @@ available at http://www.digip.org/jansson/doc/. To generate HTML documentation yourself, invoke:: - cd doc/ - sphinx-build . .build/html + make html -... and point your browser to ``.build/html/index.html``. Sphinx_ is +and point your browser to ``doc/_build/html/index.html``. Sphinx_ is required to generate the documentation. .. _Jansson: http://www.digip.org/jansson/ .. _`MIT license`: http://www.opensource.org/licenses/mit-license.php -.. _Python: http://www.python.org/ .. _reStructuredText: http://docutils.sourceforge.net/rst.html .. _Sphinx: http://sphinx.pocoo.org/