Skip to main content

A markdown extension for python documentation

Project description

jetblack-markdown

Markdown extensions for automatic document generation (read the docs).

Markdown Extension

A markdown extension is provided for automatically documenting python code.

Modules are referred to as follows:

# A Top Level Module

@[jetblack_markdown]

# A Package

@[jetblack_markdown.autodoc]

# A function

@[jetblack_markdown.autodoc:makeExtension]

# A class

@[jetblack_markdown.autodoc.metadata:PropertyDescriptor]

mkdocs integration

This site was generated using mkdocs and the following config:

site_name: jetblack-markdown

docs_dir: documentation
site_dir: docs

markdown_extensions:
  - admonition
  - codehilite
  - jetblack_markdown.autodoc:
      class_from_init: true
      ignore_dunder: true
      ignore_private: true
      ignore_all: false
      prefer_docstring: true
      template_folder: null

extra_css:
    - css/custom.css

Configuration

There are some configuration parameters.

  • class_from_init (bool, optional): If True use the docstring from the __init__ function for classes. Defaults to True.
  • ignore_dunder (bool, optional): If True ignore __XXX__ functions. Defaults to True.
  • ignore_private (bool, optional): If True ignore methods (those prefixed _XXX). Defaults to True.
  • ignore_all (bool): If True ignore the __all__ member.
  • prefer_docstring (bool): If true prefer the docstring.
  • template_folder(Optional[str], optional): Specify a custom template folder. The template "main.jinja2" will be rendered passing an obj parameter which is a jetblack.markdown.metadata.Descriptor

Customizing

All the rendering is done with jinja2 templates. Start by copying the current templates from jetblack_markdown/templates and specify the template_folder in the mkdocs.yml.

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 jetblack-markdown, version 0.5.0
Filename, size File type Python version Upload date Hashes
Filename, size jetblack_markdown-0.5.0-py3-none-any.whl (21.2 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size jetblack-markdown-0.5.0.tar.gz (14.0 kB) File type Source Python version None 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 DigiCert DigiCert EV certificate StatusPage StatusPage Status page