sphinx-autogen(1) User Commands sphinx-autogen(1)NAME
sphinx-autogen - generate ReStructuredText using autosummary directives
SYNOPSIS
sphinx-autogen [-o output_dir] [-s suffix] sourcefile...
OPTIONS -o, --output-dir=output_dir,
the directory the output files should be written to
-s, --suffix=suffix
the suffix of the written files (defaults to rst)
-t, --templates=directory
custom template directory
DESCRIPTION
sphinx-autogen is a frontend to sphinx.ext.autosummary.generate. It generates the ReStructuredText files from the autosummary directives
contained in the given input files.
The format of the autosummary directive is documented in the sphinx.ext.autosummary Python module and can be read using
pydoc sphinx.ext.autosummary
SEE ALSO sphinx-quickstart(1), sphinx-build(1)
The Sphinx website <http://sphinx.pocoo.org/>
AUTHOR
This man page was written by Jan Dittberner <jan@dittberner.info> for the Debian GNU/Linux System (but may be used by others).
Sphinx 1.1 Aug 2010 sphinx-autogen(1)
Check Out this Related Man Page
SPHINX-APIDOC(1) Sphinx SPHINX-APIDOC(1)NAME
sphinx-apidoc - Sphinx API doc generator tool
SYNOPSIS
sphinx-apidoc [options] -o <outputdir> <sourcedir> [pathnames ...]
DESCRIPTION
sphinx-apidoc is a tool for automatic generation of Sphinx sources that, using the autodoc extension, document a whole package in the style
of other automatic API documentation tools.
sourcedir must point to a Python package. Any pathnames given are paths to be excluded from the generation.
OPTIONS -o <outputdir>
Directory to place the output files. If it does not exist, it is created.
-f, --force
Usually, apidoc does not overwrite files, unless this option is given.
-n, --dry-run
If given, apidoc does not create any files.
-s <suffix>
Suffix for the source files generated, default is rst.
-d <maxdepth>
Maximum depth for the generated table of contents file.
-T, --no-toc
Do not create a table of contents file.
-F, --full
If given, a full Sphinx project is generated (conf.py, Makefile etc.) using sphinx-quickstart.
These options are used with -F:
-H <project>
Project name to put into the configuration.
-A <author>
Author name(s) to put into the configuration.
-V <version>
Project version.
-R <release>
Project release.
SEE ALSO sphinx-build(1)AUTHOR
Etienne Desautels, <etienne.desautels@gmail.com>, Georg Brandl <georg@python.org> et al.
COPYRIGHT
2007-2011, Georg Brandl
1.1.3 June 10, 2014 SPHINX-APIDOC(1)
i would like to be able rewrite the same info in 3 different files
/path/file1.ext
/path/file2.ext
/path/file3.ext
can u help me please with shell script ?
lets say i want to write "12345"
thanks (6 Replies)
I downloaded the CVS and followed the instructions at Wiki.
I typed ./autogen.sh and got:
sh: autom4te: command not found
aclocal: autom4te failed with exit status: 127
What's wrong? (1 Reply)
trying to evaluate some files....
synopsis": list all files with .xml ext.....remove the .xml ext...
then use the file without the .xml ext and pass through two style sheets...one returning the filename with .xml ext and the other returning filename with .OK
got errors........ (4 Replies)
Hi All,
How can I work on following request?
Delete all the html files older than 29th November from the path - /dding/ting/tong/unixyang/output (4 Replies)
Hi,
I have some log files created in the following fashion
Ex:
file name modified date
1) s.log1 01-jan-08
2) s.log2 02-jan-08
3) s.log3 03-jan-08
4) s.log4 04-jan-08
Now I want to have the latest 2 logs and delete the others.
Can you tell me the one liner /... (1 Reply)
I have a directory of files that look like filename 001.ext, filename 002.ext, etc. I'd like to rename the files with unique random numbered names, so that the original filenames are stripped and the files are given a new, random number name. I'm not super new to UNIX, but I don't often use it for... (2 Replies)
i have something like below in my SAS code and every month i need to append a text say 'ext.hlc_sum0906' near ext.hlc_sum0905 and next month after ext.hlc_sum0906 i need to append this 'ext.hlc_sum0907' and so on like that.. is it possible using SED or some other command in unix?
%let... (1 Reply)
if I want to search those files which were suffix with .c,
I can use find ./ -name *.c
but how to find out those files which were not suffix with .c ??
Thanks a lot! (2 Replies)
I have a file a.txt which contains the date and time.
22/Aug/2010:02:03:00
21/Aug/2010:00:00:00
21/Aug/2010:00:02:00
22/Aug/2010:00:00:00
22/Aug/2010:01:00:00
22/Aug/2010:02:00:01
22/Aug/2010:03:00:00
How to get the lines greater than or equal to 21\/Aug\/2010:06:00:00 and less than or... (8 Replies)
When I run autogen.sh(the auto hell stuffs+configure) and type "make distclean", I get a proper result(which can be built).
However, when running autogen.sh and then "make distcheck", I get an error:
...
rm -f Makefile
ERROR: files left in build directory after distclean:
./src/MediaPlayer.c... (2 Replies)
Hi All,
I need to create a script to monitor a dir for new files with ext .err and also it should b a non empty files. and perform a action or command .
We have a new ETL application that runs on a linux server, every times a etl fails it creates a .err file or updates the existing .err... (4 Replies)
Hello
I have a directory with a list of files which have a particular numerical suffix.
E.g
filename_0
filename_1
filename_18500
filename_10000
I want to delete all files from this directory which have a filename which have a numerical suffix greater than 10540.
So any files... (5 Replies)
:wall: ok this shell thing is brand new to me. I managed to log into my website ,but that is as far as I have got.
Do I have to generate a key or something to access the files on my website?
I can't even get into public_html
I just get: No such file or directory. (1 Reply)
hi team,
i have a file contains data as follows
F1 file
---------------------------
date system name
1-jan-2012 x
1-jan-2012 y
1-jan-2012 x
5-jan-2012 y
3-jan-2012 z
3-jan-2012 z
4-jan-2012 x
4-jan-2012 x
... (13 Replies)