mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
reorganized code to fit within the ext.autosummary module
This commit is contained in:
parent
59aed541f9
commit
cd6474b961
2
setup.py
2
setup.py
@ -178,7 +178,7 @@ setup(
|
|||||||
'console_scripts': [
|
'console_scripts': [
|
||||||
'sphinx-build = sphinx:main',
|
'sphinx-build = sphinx:main',
|
||||||
'sphinx-quickstart = sphinx.quickstart:main',
|
'sphinx-quickstart = sphinx.quickstart:main',
|
||||||
'sphinx-autogen = sphinx.scripts.autosummary_generate:main',
|
'sphinx-autogen = sphinx.ext.autosummary.generate:main',
|
||||||
],
|
],
|
||||||
'distutils.commands': [
|
'distutils.commands': [
|
||||||
'build_sphinx = sphinx.setup_command:BuildDoc',
|
'build_sphinx = sphinx.setup_command:BuildDoc',
|
||||||
|
@ -2,7 +2,8 @@
|
|||||||
- __init__.py
|
- __init__.py
|
||||||
- docscrape.py
|
- docscrape.py
|
||||||
- doscrape-sphinx.py
|
- doscrape-sphinx.py
|
||||||
- ../scripts/autosummary_generate.py
|
- generate.py
|
||||||
|
- templates/module.html
|
||||||
|
|
||||||
have the following license:
|
have the following license:
|
||||||
|
|
||||||
|
25
sphinx/scripts/autosummary_generate.py → sphinx/ext/autosummary/generate.py
Executable file → Normal file
25
sphinx/scripts/autosummary_generate.py → sphinx/ext/autosummary/generate.py
Executable file → Normal file
@ -1,5 +1,4 @@
|
|||||||
#!/usr/bin/env python
|
"""
|
||||||
r"""
|
|
||||||
autosummary_generate.py OPTIONS FILES
|
autosummary_generate.py OPTIONS FILES
|
||||||
|
|
||||||
Generate automatic RST source files for items referred to in
|
Generate automatic RST source files for items referred to in
|
||||||
@ -11,30 +10,29 @@ extracts the docstring of the referred item.
|
|||||||
Example Makefile rule::
|
Example Makefile rule::
|
||||||
|
|
||||||
generate:
|
generate:
|
||||||
./ext/autosummary_generate.py -o source/generated source/*.rst
|
sphinx-autogen source/*.rst source/generated
|
||||||
|
|
||||||
"""
|
"""
|
||||||
import glob, re, inspect, os, optparse
|
import glob, re, inspect, os, optparse
|
||||||
from sphinx.ext.autosummary import import_by_name
|
from sphinx.ext.autosummary import import_by_name
|
||||||
|
|
||||||
from jinja import Environment, PackageLoader
|
from jinja import Environment, PackageLoader
|
||||||
env = Environment(loader=PackageLoader('numpyext', 'templates'))
|
env = Environment(loader=PackageLoader('sphinx.ext.autosummary', 'templates'))
|
||||||
|
|
||||||
def main():
|
def main():
|
||||||
p = optparse.OptionParser(__doc__.strip())
|
p = optparse.OptionParser(__doc__.strip())
|
||||||
p.add_option("-o", "--output-dir", action="store", type="string",
|
|
||||||
dest="output_dir", default=None,
|
|
||||||
help=("Write all output files to the given directory (instead "
|
|
||||||
"of writing them as specified in the autosummary:: "
|
|
||||||
"directives)"))
|
|
||||||
options, args = p.parse_args()
|
options, args = p.parse_args()
|
||||||
|
|
||||||
if len(args) == 0:
|
if len(args) <2:
|
||||||
p.error("wrong number of arguments")
|
p.error("wrong number of arguments")
|
||||||
|
|
||||||
|
print 'generating docs from:', args[:-1]
|
||||||
|
generate_autosummary_docs(args[:-1], args[-1])
|
||||||
|
|
||||||
|
def generate_autosummary_docs(source_dir, output_dir):
|
||||||
# read
|
# read
|
||||||
names = {}
|
names = {}
|
||||||
for name, loc in get_documented(args).items():
|
for name, loc in get_documented(source_dir).items():
|
||||||
for (filename, sec_title, keyword, toctree) in loc:
|
for (filename, sec_title, keyword, toctree) in loc:
|
||||||
if toctree is not None:
|
if toctree is not None:
|
||||||
path = os.path.join(os.path.dirname(filename), toctree)
|
path = os.path.join(os.path.dirname(filename), toctree)
|
||||||
@ -42,8 +40,7 @@ def main():
|
|||||||
|
|
||||||
# write
|
# write
|
||||||
for name, path in sorted(names.items()):
|
for name, path in sorted(names.items()):
|
||||||
if options.output_dir is not None:
|
path = output_dir
|
||||||
path = options.output_dir
|
|
||||||
|
|
||||||
if not os.path.isdir(path):
|
if not os.path.isdir(path):
|
||||||
os.makedirs(path)
|
os.makedirs(path)
|
Loading…
Reference in New Issue
Block a user