nltk / epydoc

Automatic API Documentation Generation for Python

Natural Language Toolkit (NLTK)

NLTK -- the Natural Language Toolkit -- is a suite of open source Python modules, data sets, and tutorials supporting research and development in Natural Language Processing. NLTK requires Python version 3.8, 3.9, 3.10, 3.11 or 3.12.

For documentation, please visit nltk.org.

Contributing

Do you want to contribute to NLTK development? Great! Please read CONTRIBUTING.md for more details.

See also how to contribute to NLTK.

Donate

Have you found the toolkit helpful? Please support NLTK development by donating to the project via PayPal, using the link on the NLTK homepage.

Citing

If you publish work that uses NLTK, please cite the NLTK book, as follows:

Bird, Steven, Edward Loper and Ewan Klein (2009).
Natural Language Processing with Python.  O'Reilly Media Inc.

Copyright

Copyright (C) 2001-2023 NLTK Project

For license information, see LICENSE.txt.

AUTHORS.md contains a list of everyone who has contributed to NLTK.

Redistributing

• NLTK source code is distributed under the Apache 2.0 License.
• NLTK documentation is distributed under the Creative Commons Attribution-Noncommercial-No Derivative Works 3.0 United States license.
• NLTK corpora are provided under the terms given in the README file for each corpus; all are redistributable and available for non-commercial use.
• NLTK may be freely redistributed, subject to the provisions of these licenses.

epydoc's Issues

pypi update?

The version in pypi is 3.0.1 from 2008 and is not compatible with Python 3. Are there plans to update the package?

Python3 tests are failling

Hello,

Thanks for the effort to make it compatible with python3. But I think the struggle is not over.

Running

export PYTHONPATH=src
python3.8 src/epydoc/test/__init__.py

Generates 5 failures.

I was just wondering if your team was interesting into maintaining this fork or not?

Or maybe the other thing to do would be to improve pydoctor (partly based on epydoc's source code), in order to add the few features and "touch" from epydoc that are still missing. At the same time, this would reduce the burden of debugging py2/py3 code as pydoctor developpers already done it.

Port to Python 3

Port epydoc to Python 3, with the help of 2to3.py, and test on the nltk_book repository (cd book; make ch01.html).

Unable to generate uml diagrams with docs for django rest framework

epydoc --html --graph classtree  ~/uenv/lib/python2.7/site-packages/rest_framework/generics.py
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------
| In /home/batta/uenv/lib/python2.7/site-packages/rest_framework/generics.py:
| Import failed (but source code parsing was successful).
|     Error: ImportError: No module named settings (line 11)
|   
Warning: No information available for rest_framework.views.APIView's base django.views.generic.View
Warning: Unable to render Graphviz dot graph:
         [Errno 2] No such file or directory

It is generating docs but, I'm unabe to see class diagrams in docs.