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.0rc3.tar.gz (13.1 kB view details)

Uploaded Source

File details

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

File metadata

  • Download URL: sphinx-asdf-0.1.0rc3.tar.gz
  • Upload date:
  • Size: 13.1 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.6.3 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.2

File hashes

Hashes for sphinx-asdf-0.1.0rc3.tar.gz
Algorithm Hash digest
SHA256 245783e4218d7c4b920d396db36cf8259f0d3583a69903c06ecb0bbdf999781d
MD5 4796d3df2301bd65477c9673c7f800e7
BLAKE2b-256 53d527e1060185bb806fecaf998c5d661249746f4fc9cb7d6d696f4d74001a5e

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