https://github.com/spirali/nedoc

Generator of API documentation for Python
https://github.com/spirali/nedoc

documentation python

Last synced: 3 months ago
JSON representation

Generator of API documentation for Python

• Host: GitHub
• URL: https://github.com/spirali/nedoc
• Owner: spirali
• License: mit
• Created: 2018-12-12T17:33:34.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-03-20T17:06:14.000Z (8 months ago)
• Last Synced: 2024-07-25T09:19:21.321Z (4 months ago)
• Topics: documentation, python
• Language: Python
• Size: 327 KB
• Stars: 13
• Watchers: 4
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

# Nedoc (Non-Evaluating Documentation)

*Nedoc* is a generator of API documentation for Python 3 with the following features:

* Your code is not executed; Your program and its dependencies do not have to be installed.

* Nedoc tracks which methods were overridden and show it in the documentation.

* Inheritance of docstrings for overridden methods is supported.

* Nedoc tracks what and where was reimported.

* Resulting documentation is a set of static HTML files.

* Supported docstring styles: numpydoc, google, rst

* Supported docstring markup: markdown, rst

## Examples

* *Django* documentation generated by Nedoc: https://spirali.github.io/nedoc-demo/django/django.html

* *Dask/Distributed* documentation generated by Nedoc: https://spirali.github.io/nedoc-demo/distributed/distributed.html



## Installation

```

$ pip3 install nedoc

```

## Getting started (short version)

```

python3 -m nedoc init MyProjectName /path/to/project

python3 -m nedoc build

firefox html/index.html

```

## Getting started (longer version)

First, we need to generate `nedoc.conf`; *PathToProject* should lead to the toplevel

directory with Python source codes (usually the directory containing toplevel

`__init__.py`; however, `__init__.py` does not have to exist).

```

python3 -m nedoc init  

```

The command creates `nedoc.conf` in the current working directory. You can edit

it for more customized settings.

The documentation is built by the following command:

```

python3 -m nedoc build

```

By default, you can find the results in `html` directory.