Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

move main docstring into a file #57

Merged
merged 5 commits into from May 1, 2019
Merged
Changes from 1 commit
Commits
File filter...
Filter file types
Jump to…
Jump to file or symbol
Failed to load files and symbols.
+6 −6
Diff settings

Always

Just for now

move intro paragraph back into source code

  • Loading branch information...
cs01 committed May 1, 2019
commit b2753146bc2cb2487323b14299bec9b0610197d7
@@ -1,4 +1,10 @@
"""
Python package `pdoc` provides types, functions, and a command-line
interface for accessing public documentation of Python modules, and
for presenting it in a user-friendly, industry-standard open format.
It is best suited for small- to medium-sized projects with tidy,
hierarchical APIs.
.. include:: ./documentation.md
"""
import ast
@@ -1,9 +1,3 @@
Python package `pdoc` provides types, functions, and a command-line
interface for accessing public documentation of Python modules, and
for presenting it in a user-friendly, industry-standard open format.
It is best suited for small- to medium-sized projects with tidy,
hierarchical APIs.

`pdoc` extracts documentation of:

* modules (including submodules),
ProTip! Use n and p to navigate between commits in a pull request.
You can’t perform that action at this time.