Mercurial > p > roundup > code
view README.txt @ 6763:d93b441ee778
Handle build issues, update css for mobile
I added www.roundup-tracker.org as a property of mine in google search
console. It reports bad mobile experience.
According to the goatcounter tracker I put in, we get 400 hits from
phones/small tablets; 400 from tablets/small laptops and 800 from
computer screens. So 1/4 is mobile and 1/2 is not a large computer
screen.
On mobile (<960px) the left hand menu is stacked on top of the column
in mobile sizes. Sub-menu links are spaced apart to make them easier
to clkick on with a finger. Same with the table of contents in the
documents. The main document content is now full display width (rather
than scrunched to the right side of the display). This is just a quick
hack, but it should make the docs more usable.
As I worked, I found that _static/style.css changes were not being
copied into the html build directory when sphinx was rerun. Nuke
entire html subdir and rebuild from scratch each time. Also added
comments to Makefile.
Also robots.txt was being added as extra_html by sphinx, but it causes
a missing from TOC error that exits the build (when using -W). Since
exiting on warning is better, I changed Makefile to add
robots.txt. Removed robots.txt references from conf.py.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Sun, 10 Jul 2022 18:16:13 -0400 |
| parents | bbfc87ecfdf1 |
| children | 49761be4a931 |
line wrap: on
line source
======================================================= Roundup: an Issue-Tracking System for Knowledge Workers ======================================================= INSTANT GRATIFICATION ===================== The impatient may try Roundup immediately by running demo.py from the source directory:: python demo.py This will create new tracker home in "demo" subdirectory and start server. To reset demo instance:: python demo.py nuke Tracker Home ============= "Tracker Home" is main concept when starting with Roundup. It is directory where all your tracker data is stored. This directory is created every time when new tracker is initialized and includes tracker configuration, database, template, schema and extensions. Installation ============ Please see "doc/installation.txt" Upgrading ========= Please see "doc/upgrading.txt" Usage and Other Information =========================== Start with the index.txt file in the "doc" directory. These documentation files are written in reStructedText, which can be converted into HTML format. If you have Sphinx installed, you can do this by running:: python setup.py build_doc Resulting HTML files will be in "share/doc/roundup/html" directory. For Developers ============== To get started on development work, read the developers.txt file in the "doc" directory. License ======= See COPYING.txt