https://github.com/malept/sphinx-inventory

Library to write Sphinx inventory files
https://github.com/malept/sphinx-inventory

Last synced: 4 days ago
JSON representation

Library to write Sphinx inventory files

• Host: GitHub
• URL: https://github.com/malept/sphinx-inventory
• Owner: malept
• License: apache-2.0
• Created: 2014-04-02T20:07:31.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-04-10T03:11:26.000Z (over 10 years ago)
• Last Synced: 2024-10-24T16:08:35.112Z (14 days ago)
• Language: Python
• Size: 156 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

README

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

Sphinx Inventory Writer

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

.. image:: https://travis-ci.org/malept/sphinx-inventory.svg?branch=master

   :target: https://travis-ci.org/malept/sphinx-inventory

A standalone library to write Sphinx_ inventory files (format version 2),

outside of Sphinx. These files can be used for cross-referencing identifiers

when writing documentation. An example of how these files are used can be found

with Sphinx's `intersphinx extension`_.

.. _Sphinx: http://sphinx-doc.org/

.. _intersphinx extension: http://sphinx-doc.org/ext/intersphinx.html

Requirements

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

* CPython 2.6/2.7/3.3/3.4 or PyPy

Installation

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

Run the following:

.. code-block:: shell-session

   user@host:~$ pip install git+https://github.com/malept/sphinx-inventory.git