Create python api docs (perhaps as part of build)

[pki-bot]

This issue was migrated from Pagure Issue #1157. Originally filed by vakwetu (@vakwetu) on 2014-09-11 22:01:17:

• Closed as Fixed
• Assigned to vakwetu (@vakwetu)

---

The way to do it is using sphinx.

Here is a quick start on how to gen api docs:

yum install python-sphinx
sphinx-apidoc -F -o /tmp/api-docs <src_path>/pki/base/common/python
cd /tmp/api-docs
make html
firefox ./_build/html/index.html

[pki-bot]

Comment from mharmsen (@mharmsen) at 2014-09-24 20:57:10

Per Dogtag 10.2.3 Triage meeting of 09/24/2014 - proposed Milestone: 10.2.1

[pki-bot]

Comment from vakwetu (@vakwetu) at 2014-10-27 20:29:01

Added to build.

[alee@aleeredhat pki]$ git push origin master
Counting objects: 108, done.
Delta compression using up to 8 threads.
Compressing objects: 100% (33/33), done.
Writing objects: 100% (34/34), 11.60 KiB | 0 bytes/s, done.
Total 34 (delta 21), reused 0 (delta 0)
To ssh://vakwetu@git.fedorahosted.org/git/pki.git
a3bd504..8d8e33b master -> master

[pki-bot]

Comment from vakwetu (@vakwetu) at 2017-02-27 14:07:14

Metadata Update from @vakwetu:

• Issue assigned to vakwetu
• Issue set to the milestone: 10.2.1