Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

ogc-plugins-spec-doc, an ogc plugin for building documentation from spec files

Project description

Build Status

ogc-plugins-spec-doc

generate documentation from spec files

usage

In a ogc spec, place the following:

plan:
  - specdoc:
    file-glob: **/*spec.yml
    top-level-dir: specs

In order for documentation to be generated for a spec the following is required:

meta:
  name: Name of spec
  description: Description of spec
  long-description: |
    # Longer markdown supported text

These are the minimum requirements for the spec to be processed into documentation.

see ogc spec-doc specdoc for more information.

Project details


Download files

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

Files for ogc-plugins-spec-doc, version 1.0.7
Filename, size File type Python version Upload date Hashes
Filename, size ogc_plugins_spec_doc-1.0.7-py3-none-any.whl (3.5 kB) File type Wheel Python version py3 Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page