Mercurial > p > roundup > code
view website/www/code.txt @ 7787:2ab234484708
docs: add older docs and link them from a Sphinx controlled doc
doc/sc.txt
I can't reference html docs relatively directly from a sphinx
toctree. So I created a new sc.txt to link to the existing:
software carpentry overview (precursor to overview.txt)
software carpentry design (precursor to design.txt)
I also added a link to a short paper that Ka-Ping Yee wrote on
Roundup's prototype and issues with other systems (bugzilla/jitterbug).
doc/design.txt
add link to the original precursor doc spec.html.
doc/html_extra/roundup_short_paper.html, doc/html_extra/images/jitterbug-2.gif
The paper, lightly edited to make image references work. Original
location/name was: http://www.lfw.org/ping/roundup.html aka
http://zesty.ca/roundup.html.
Also added one missing image. Other images were committed some time ago.
website/www/olderdocs.txt
add link to new sc.txt
website/www/Makefile
copy the three docs and images to the published tree.
Tried to use html_extra conf.py parameter as is done in the docs
directory that creates share/docs/roundup/html as part of the release
process. But that results in the file going to the top level
directory of www.roundup.com and not to the docs subdirectory. There
seems to be no way to control this, so makefile cp rule for the win.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Tue, 05 Mar 2024 13:03:46 -0500 |
| parents | 6f5054751fb6 |
| children | 141225d2981e |
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>`. 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.