Skip to main content

Mkdoc plugin to autodoc your numpy docstring

Project description

NumKdoc

pypi

NumKdoc is a plugin for Mkdoc allowing you to automatically generate documentation from your Numpy style docstring, by making a simple call to classes.

This project is not maintained, and the parsing is not complete. It is based on the NumpyDoc parser.

Quick start

If you want to try this plugin as-it-is, follow these steps:

  1. Download this repo and (eventually) unzip it in a folder

  2. Inside the project folder, execute the command python setup.py develop to install the plugin on your local machine.

  3. Go to your mkdocs project folder, edit the mkdocs.yml file and add these few lines at the end:

    plugins:
      - numkdoc
    

That's it. Now you can call the parsing of a class using the tag {{ module.ClassName }}, Numkdoc will automatically substitue that tag with the class documentation.

Example

For example, you could edit the docs/api/core.md file and insert the tag in any place, like this:

# Core Api

[...]

{{ src.module.Class }}

[...]

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

Numkdoc-0.4.2.tar.gz (5.8 kB view details)

Uploaded Source

Built Distribution

Numkdoc-0.4.2-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

Details for the file Numkdoc-0.4.2.tar.gz.

File metadata

  • Download URL: Numkdoc-0.4.2.tar.gz
  • Upload date:
  • Size: 5.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for Numkdoc-0.4.2.tar.gz
Algorithm Hash digest
SHA256 a9897528a0ac7cf7e6d5a51cbfa1e3dfbd5e12d27f13ffe75df9eef5009aeaad
MD5 85a10ffe4d563042a48026bfaef8969d
BLAKE2b-256 ff9c2091d0067b02685f2cfb27499c8ad11e019da4f76c1155c5c915ee697742

See more details on using hashes here.

Provenance

File details

Details for the file Numkdoc-0.4.2-py3-none-any.whl.

File metadata

  • Download URL: Numkdoc-0.4.2-py3-none-any.whl
  • Upload date:
  • Size: 6.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for Numkdoc-0.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 544923be09288d08fdd72a7903647c1efa0fbb2f68b82e47a8f432201157dd43
MD5 0c11756c99989c209aa171358d1b97d3
BLAKE2b-256 a055454551eec83c9271cb218d50802b0d5ba492721fa3f8f008603fa9a1a311

See more details on using hashes here.

Provenance

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