aboutsummaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* doc:install: we only use CherryPy for HTTPS.W. Trevor King2012-08-291-2/+2
| | | | We use wsgiref.simple_server for HTTP.
* doc:tutorial: document `be serve-storage`.W. Trevor King2012-08-291-3/+17
|
* Update CherryPy dependency package to python-cherrypy3 on Debian.W. Trevor King2012-05-101-8/+8
| | | | | | | | | | | | | | | | Thanks to Tim Mazid for reporting the bug, and Israel Basurto for suggesting the fix. On Wed, May 09, 2012 at 07:26:14PM +1000, Tim Mazid wrote: > $ interfaces/web/cfbe.py ~/projects/proj/ > Bugs Everywhere Directory v1.4 > Traceback (most recent call last): > File "interfaces/web/cfbe.py", line 42, in <module> > cherrypy.quickstart(WebInterface, '/', app_config) > AttributeError: 'module' object has no attribute 'quickstart' > > This is with the latest be from git, and python-cherrypy 2.3.0-3 from > Debian wheezy.
* Fix deb-python -> dev-python typo in doc/install.txt.W. Trevor King2012-04-261-1/+1
|
* Oops, forgot to bump the version and date when tweaking the man page.W. Trevor King2012-02-251-2/+2
|
* Use a bare URL for the link from the man page to online docs.W. Trevor King2012-02-251-4/+3
| | | | | This will make it easier (possible?) for people using the roff version of the man page to follow the link.
* Use $ instead of % for the prompt in the man page bug submission example.W. Trevor King2012-02-251-3/+3
|
* Add CherryPy dependency and minimal install info to doc/install.txt.W. Trevor King2012-02-252-21/+69
| | | | | | | | | | | | | | | | I seem to have left CherryPy out of the earlier list. The extra handholding for minimal installations is an attempt to address problems people have had installing BE on non-Linux systems, where the standard build tools are less common. I also mention my Gentoo overlay and Michel Alexandre Salim's Fedora package, so people running Gentoo and Fedora don't have to bother figuring any of this out ;). Finally, I moved the package information up to the top of the install page, so people on supported systems realize they have an easy out before reading through the install procedure.
* Shuffle doc/conf.py to get the Git revision into the Sphinx documentation.W. Trevor King2012-02-171-10/+12
|
* Ran update-copyright.py.W. Trevor King2012-02-161-10/+10
|
* Mention `~/.local/bin/` when using default `--user` install.W. Trevor King2011-11-081-1/+3
|
* Correct doc/install.txt to refer to INSTALL_OPTIONS instead of PREFIX.W. Trevor King2011-11-081-2/+2
| | | | | | | This catches the docs up with the changes made in: commit a7ad89a6ad7da55089e6f9a4cdd645b7079ee04e Author: W. Trevor King <wking@drexel.edu> Date: Sat Apr 16 21:26:02 2011 -0400
* Add Jinja to the dependency documentation.W. Trevor King2011-09-071-0/+2
|
* Add 'Power features' page to the docs.W. Trevor King2011-05-252-0/+28
|
* Run update_copyright.py.W. Trevor King2011-05-251-1/+2
|
* Mention Stats.print_callees() in doc/hacking.txt.W. Trevor King2011-05-121-0/+4
|
* Mention Stats.print_callers() in doc/hacking.txt.W. Trevor King2011-05-121-3/+7
|
* Fix links to libbe.util.id from doc/tutorial.txt.W. Trevor King2011-05-111-3/+3
|
* Fix `IDs` and `Mercurial guide` links in docs.W. Trevor King2011-02-232-4/+4
|
* Numpydoc is distributed in Gentoo's science overlay.W. Trevor King2011-01-101-1/+4
|
* Update link to Numpy docstring guidelines.W. Trevor King2011-01-101-1/+1
|
* Use Docutils' rst2doc instead of DocBook XML to generate man page.W. Trevor King2011-01-104-170/+86
|
* Bumped to version 1.0.01.0.0Chris Ball2011-01-081-1/+1
|
* Merge branch 'master' of http://www.physics.drexel.edu/~wking/code/git/beChris Ball2011-01-081-7/+6
|\
| * Cleanup linking from doc/tutorial.txt to email and HTTP docs.W. Trevor King2010-12-061-7/+6
| |
* | Clarify that bugs cannot contain multi-line descriptionsDieter Plaetinck2010-10-311-4/+5
|/
* 'be vXXX' -> 'be XXX' in Sphinx-generated docs to avoid git-hash confusion.W. Trevor King2010-10-221-0/+8
|
* Document command line overrides for built documentation.W. Trevor King2010-10-221-0/+17
|
* Point out that official packages may not be up to date.W. Trevor King2010-10-121-0/+2
|
* Add manpage/DocBook section to doc/doc.txt.W. Trevor King2010-09-281-0/+21
|
* Add dependency section to doc/install.txt.W. Trevor King2010-09-281-0/+32
|
* Wrap `rm` in the RM variable in doc/Makefile.W. Trevor King2010-09-281-1/+2
| | | | This is more consistent with the example set by the root Makefile.
* Converted man page source to DocBook V5.0.W. Trevor King2010-09-282-134/+133
| | | | | | | | This has the dual benefits of keeping up with the current DocBook standard as well as removing the dependency on SGML parsers like docbook-to-man and docbook2man which may not be available on all systems. An XSLT processor and the DocBook style sheets are easier dependencies to satisfy.
* Fixed mnt -> mtn typos in doc/spam.txtThomas Keller2010-06-271-1/+1
|
* Added CFBE invocation notes to doc/http.txt.W. Trevor King2010-06-261-3/+9
| | | | This closes #bea/c72# and its dependent tag #bea/e23#.
* Moved doc/html.txt -> doc/http.txt.W. Trevor King2010-06-262-2/+2
| | | | | `be html` is an HTML interface, but only CFBE (and `be serve`) use HTTP.
* Updated docs b/c of new Monotone backendW. Trevor King2010-06-263-20/+30
|
* Converted Bzr -> Git references in README and doc/*.txtW. Trevor King2010-06-241-8/+8
|
* Ran update_copyright.pyW. Trevor King2010-06-221-1/+16
|
* Merge from Trevor.Chris Ball2010-06-225-43/+47
|\
| * Merged Chris' tutorial BE server URL updateW. Trevor King2010-06-221-4/+4
| |\ | |/ |/|
* | Change location of be --serve'd bugs URL to http://bugs.bugseverywhere.org/Chris Ball2010-06-221-4/+4
| |
* | Merge with TrevorChris Ball2010-06-221-1/+8
|\ \
* \ \ Merge with Trevor.Chris Ball2010-06-2014-43/+1054
|\ \ \
| | | * Many markup fixes in doc/W. Trevor King2010-06-225-43/+47
| | |/ | | | | | | | | | | | | | | | | | | | | | Also added subdir option to generate-libbe-txt.make_module_txt(), in the hopes that subdir='.' would fix the missing reference errors, but no luck (although it did reduce them). I'm sticking with subdir='libbe' for now to avoid cluttering doc/ with autogenerated cruft.
| | * Use Sphinx autosummary (required by numpydoc)wking2010-06-221-1/+2
| | |
| | * Added intersphinx_mapping to doc/conf.py.wking2010-06-221-0/+6
| |/ | | | | | | | | See http://sphinx.pocoo.org/ext/intersphinx.html#confval-intersphinx_mapping
| * Merged initial Sphinx documentation structure.W. Trevor King2010-02-0815-125/+579
| |\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | There's still a long way to go in this direction, but the basic framework is now in place. Toss in numpydoc-style docstrings http://projects.scipy.org/numpy/wiki/CodingStyleGuidelines when you have time, and things will gradually improve over time. I also punted our user ID creation/parsing in libbe.ui.util.user to the email module. This way IDs are handled in an RFC-compliant way (less suprising for users) and by someone else (less work for us :).
| | * Consolidated Makefile and doc/man/module.mk. Incorperated doc/Makefile.W. Trevor King2010-02-082-55/+16
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Now make sphinx builds the Sphinx HTML documentation (in doc/.build/html), and make clean cleans up everything. Having a separate module.mk was just making things confusing, so I took it out ;).
| | * Fixed docstrings so only Sphinx errors are "autosummary" and "missing attribute"W. Trevor King2010-02-074-56/+2
| | |
generated by cgit (git 2.34.1) at 2024-11-10 12:57:31 +0000