Tasks #1006
Create fancy title page for RSB manual
| Status: | Resolved | Start date: | 06/18/2012 | |
|---|---|---|---|---|
| Priority: | High | Due date: | ||
| Assignee: | - | % Done: | 100% | |
| Category: | Documentation | |||
| Target version: | rsb-0.7 |
Description
The initial entry point for the documentation as generated through Sphinx is not very intuitive. I would propose to add a specific landing page similar as done in the NaoQi SDK or http://www.openrobots.org/morse/doc/latest/morse.html.
If a user is interested in the linear structure that is proposed by Sphinx (Concepts-->Preparation-->Tutorial-->...) we may also visualize this graphically on the start page.
Related issues
Associated revisions
Added initial draft of a landing page
refs #1006
refs #1006
- index.rst: moved text to concepts.rst
- concepts.rst: added text from index.rst
- _templates/index.html: new file; contains landing page
- conf.py.in: added _templates/index.html to additional pages
Removed auto-generated links in index.html
fixes #1006
fixes #1006
- index.html: removed auto-generated search, index, etc. links since
some were broken
Added custom theme
refs #1006
refs #1006
- conf.py.in: use corlab theme
- _templates/index.html: added icons to headings
- corlab/theme.conf: new file; theme meta-data file
- corlab/static/corlab.css: new file; stylesheet for theme
- _static/install.svg: new file; used by theme
- _static/news.svg: likewise
- _static/specification.svg: likewise
- _static/tools.svg: likewise
- _static/tutorial.svg: likewise
- _static/whatis.svg: likewise
History
#1 Updated by S. Wrede almost 12 years ago
We should also add our publications somewhere on the web page using a the same link as in the toolkit catalogue.
#2 Updated by J. Moringen almost 12 years ago
- Subject changed from Create Landing Page for RSB / RSB Documentation to Create fancy title page for RSB manual
- Description updated (diff)
- Assignee set to M. Goetting
- Priority changed from Low to Normal
#3 Updated by J. Moringen almost 12 years ago
- Priority changed from Normal to High
#4 Updated by J. Moringen almost 12 years ago
- Status changed from New to In Progress
- Assignee changed from M. Goetting to J. Moringen
I will try to do this.
#5 Updated by J. Moringen almost 12 years ago
- Status changed from In Progress to Feedback
- % Done changed from 0 to 60
#6 Updated by J. Moringen almost 12 years ago
- Assignee deleted (
J. Moringen)
#7 Updated by J. Wienke almost 12 years ago
There are some broken auto-generated links on the site and I would add a usual TOC in the left sidebar. Apart from that I am happy with the version.
#8 Updated by J. Moringen almost 12 years ago
- Status changed from Feedback to Resolved
- % Done changed from 60 to 100
Applied in changeset r3744.