Skip to main content

Sphinx plugin for generating documentation from ASDF schemas

Project description

sphinx-asdf is a plugin for sphinx that enables generation of documentation from ASDF schemas.

Installation

The latest development version is available from the master branch on github. To clone the project:

$ git clone https://github.com/spacetelescope/sphinx-asdf

To install:

$ cd sphinx-asdf
$ pip install .

To install in development mode:

$ pip install -e .

Contributing

We welcome feedback and contributions to the project. Contributions of code, documentation, or general feedback are all appreciated. Please follow the contributing guidelines to submit an issue or a pull request.

We strive to provide a welcoming community to all of our users by abiding to the Code of Conduct.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx-asdf-0.1.0rc2.tar.gz (13.0 kB view details)

Uploaded Source

File details

Details for the file sphinx-asdf-0.1.0rc2.tar.gz.

File metadata

  • Download URL: sphinx-asdf-0.1.0rc2.tar.gz
  • Upload date:
  • Size: 13.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.2

File hashes

Hashes for sphinx-asdf-0.1.0rc2.tar.gz
Algorithm Hash digest
SHA256 51821668525b6454d6ea0314182e74a7f5501aa07c5697520483b0cdd1a8bdb4
MD5 0de095aeb7602e76c27bf1a2ce5410b2
BLAKE2b-256 27d925b324a408178bf3048404e392ffc3707540589acf6c87c34e315a5f9f93

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page