Opened 10 years ago
Closed 10 years ago
#11895 closed enhancement (fixed)
Use package info in documentation configuration file
Reported by: | Ryan J Ollos | Owned by: | Ryan J Ollos |
---|---|---|---|
Priority: | normal | Milestone: | 1.0.4 |
Component: | general | Version: | |
Severity: | normal | Keywords: | apidoc |
Cc: | Branch: | ||
Release Notes: |
Package info is used in ApiDocs generator configuration file to populate the version, configuration and svn revision. |
||
API Changes: | |||
Internal Changes: |
Description
The documentation configuration file, tags/trac-1.0.2/doc/conf.py, contains some constants that need to be updated with every release: TracDev/ReleaseChecklist@52. The info could be pulled retrieved from the package:
Python 2.7.6 (default, Mar 22 2014, 22:59:56) [GCC 4.8.2] on linux2 Type "help", "copyright", "credits" or "license" for more information. >>> import sys >>> from trac.util import get_pkginfo >>> pkg_info = get_pkginfo(sys.modules['trac']) >>> print pkg_info {'description': ' Trac is a minimalistic web-based software project management and bug/issue\n tracking system. It provides an interface to the Subversion revision control\n systems, an integrated wiki, flexible issue tracking and convenient report\n facilities.\n ', 'license': 'BSD', 'author': 'Edgewall Software', 'author_email': 'trac-dev@googlegroups.com', 'summary': 'Integrated SCM, wiki, issue tracker and project environment', 'home_page': 'http://trac.edgewall.org/', 'version': '1.1.3dev-r13575'}
Attachments (2)
Change History (7)
by , 10 years ago
Attachment: | sphinx-err-sB3fsW.log added |
---|
by , 10 years ago
Attachment: | apidoc.log added |
---|
comment:2 by , 10 years ago
Milestone: | 1.0.3 → next-stable-1.0.x |
---|
comment:3 by , 10 years ago
ImportError: No module named genshi.builder
It seems that Genshi isn't installed in global site-packages. Installing sphinx to virtualenv and using it instead of sphinx in packages would fix it.
comment:4 by , 10 years ago
Milestone: | next-stable-1.0.x → 1.0.4 |
---|---|
Status: | new → assigned |
Thanks, I'll test again and commit the changes, then update TracDev/ReleaseChecklist.
comment:5 by , 10 years ago
Release Notes: | modified (diff) |
---|---|
Resolution: | → fixed |
Status: | assigned → closed |
Committed to 1.0-stable in [13674], merged to trunk in [13675]. Edited TracDev/ReleaseChecklist@61.
I've always seen multiple instances of the error when running
make apidoc
:Full output in attachment:apidoc.log.
The same error results when trying to import
from trac.util import get_pkginfo
inconf.py
for log:rjollos.git:t11895: attachment:sphinx-err-sB3fsW.log. However in this case it results in a hard failure.