Mercurial > p > roundup > code
view website/www/code.txt @ 8263:78b13272d41b
docs: link to Client and TemplatingUtils class/method docstrings
pydoc.txt:
new page. Has two example autodoc invocations: automethod and autoclass.
docs.txt
Added pydoc.txt as a hidden page in a new toc in docs.txt. Added
includehidden in toc directive.Not sure what it does, but was part
of a recipie to hide the pydoc from the main TOC.
conf.py:
added sphinx.ext.autodoc to get it pulling in the docs.
reference.txt:
added references to the pydoc using :py:meth: for templating utils
methods like set-http_response and :py:class: for Client as the
existing docs referenced the docstrings.
Changed table formatting for the TemplatingUtils methods from table
to list-table. The length of the references to the methods was too
large to exist in the first column of a drawn table.
For right now the pydoc stuff is only referenced via links from the
main docs. Currently it is ugly, but the additional info on tempating
utils and their arguments can be helpful.
Added sphin
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Tue, 07 Jan 2025 23:00:35 -0500 |
| parents | 141225d2981e |
| children |
line wrap: on
line source
.. meta:: :description: Information for developers of Roundup. Including directions on checking code from repository, how to run demo mode and execute tests. Code ==== Project history is maintained in `CHANGES.txt <https://sourceforge.net/p/roundup/code/ci/tip/tree/CHANGES.txt>`_ file in code repository of Roundup, which can also be viewed online through SourceForge `web interface <https://sourceforge.net/p/roundup/code/ci/default/tree/>`_. Get sources ----------- Official **read-only access** to Mercurial repository is provided through :: hg clone http://hg.code.sf.net/p/roundup/code roundup **Read/write access** requires SSH password or SSH key authorization (see `SourceForge.net docs for details <https://sourceforge.net/p/forge/documentation/Mercurial/>`_) :: hg clone ssh://USERNAME@hg.code.sf.net/p/roundup/code roundup You also need to be added as a Roundup developer for write access - ask for it on the :doc:`roundup-devel list <contact>`. You can also use the Roundup mirror on GitHub. It lags behind the Mercurial repository, but is usually only a couple of weeks old. You can clone it using:: git clone https://github.com/roundup-tracker/roundup.git Note that even though we have a mirror on GitHub we don't use Issues (use https://issues.roundup-tracker.org) or Pull requests. The GitHub mirror is used for CI. Run demo -------- Roundup doesn't need any dependencies and works out of the box. Demo is accessible at http://localhost:8917/demo/ by default :: cd roundup python demo.py Execute tests ------------- :: python -m pytest test See repository `README.txt <https://sourceforge.net/p/roundup/code/ci/tip/tree/README.txt>`_ for more info.