aboutsummaryrefslogtreecommitdiffstats
path: root/source/conf.py
Commit message (Collapse)AuthorAgeFilesLines
* conf.py: allow doxygen XML output in repository rootMarti Bolivar2014-01-151-2/+13
| | | | | | | | | | | | It's a pain to have to re-make the XML output for a given release, and there's a chance it'll change between different versions of Doxygen. So look for Doxygen XML output in doxygen/xml/ relative to the repository root. This allows maintenance branches to check in the XML for their version of libmaple. Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* Redo appearance of top-level docs and pages.Marti Bolivar2011-10-081-5/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This is a fairly significant set of changes, aimed at improving the overall usability of the documentation. Add source/_templates/indexcontent.html, which is a Jinja template used to generate index.html. This mimics the Python docs' style of having a short, styled table as main index interface. We're doing this because people keep missing the board hardware pages that are below the fold. Hopefully this will make them (and other important pages) easier to find. The new file source/_static/index-style.css controls the presentation of the generated index.html. Move the contents of source/index.rst to source/contents.rst, and increase the toctree depths to 2. This increase has the ancillary benefit that secondary headers within the current page are displayed in the sidebar, which should aid navigation within the page. contents.rst is meant to be a contents in full, where users who know what they're looking for can go. The "Table of Contents" link on the sidebar points here. Add a new source/_static/leaflabs-docs.css. It's currently unused, but is the place where people should put CSS that wants to override the defaults. Modify source/_templates/layout.html to include aforementioned leaflabs-docs.css. Also tweak the behavior of the rootrellink block, which provides the breadcrumbs in page headers and footers. Change the titles of various top-level docs so they can be referenced from the toctrees in contents.rst directly. Having two names (one in the contents, one at the top of the page) has got to be confusing people. Make an exception for FAQ so that it appears in one line on the sidebar. Adjust conf.py to reflect all of these changes. Also: - Fix "Lucidia" -> "Lucida" typo - Get rid of intersphinx_mapping (we don't use it, and including it makes it impossible to build the docs offline). - Remove the logo from sidebar; it's big and ugly and serves no purpose. Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* configuration: Cleanups and tweaks.Marti Bolivar2011-10-071-7/+3
| | | | | | | | | | | | | Start coloring visited links differently. I have no idea why that was disabled. Remove ' Documentation' from the HTML title. It's too long. Clean up some whitespace. Remove unused apilist.html and ancillary conf.py. Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
* conf.py: Add RELEASE milestone.Marti Bolivar2011-09-081-1/+1
|
* conf.py: Update copyright.Marti Bolivar2011-06-151-1/+1
|
* Initial version separate leaflabs-docs repository.Marti Bolivar2011-06-111-3/+3
| | | | | This repository previously lived in the libmaple/ repository, but that didn't make much sense, since it covers Maple IDE as well.
* Docs: Update release FIXMEs for 0.0.12.Marti Bolivar2011-06-011-1/+1
| | | | | This is a pretty brain-dead way to manage these pre-release preparations. Should figure out the done thing and use that instead.
* Make docs say their version is 'custom-build'.Marti Bolivar2011-05-261-1/+2
| | | | | This should get changed on each release branch when the time comes. A FIXME comment has been added to that effect.
* 0.0.10 beta.Marti Bolivar2011-05-111-1/+1
|
* Docs tweaks.Marti Bolivar2011-04-251-1/+1
| | | | Blocking fixes for 0.0.10; other changes.
* Untabifying docs/source/conf.pyMarti Bolivar2011-03-041-19/+19
|
* side reorder, home link, template mod to add rel bar linksHanna Mendes Levitin2010-12-021-2/+2
|
* docs, now with styleHanna Mendes Levitin2010-12-011-10/+35
|
* Finished converting the Arduino docsMarti Bolivar2010-11-291-2/+2
|
* arduino language reference nearing completion, properly CC-BY-SA 3.0 attributedMarti Bolivar2010-11-171-1/+1
|
* initial check-in of arduino docs in RST format (converted using wget+pandoc)Marti Bolivar2010-10-201-0/+1
|
* more docsMarti Bolivar2010-10-111-3/+19
|
* docsMarti Bolivar2010-10-111-1/+7
|
* lots more docsMarti Bolivar2010-10-071-4/+4
|
* some comment stubsMarti Bolivar2010-10-071-3/+3
|
* added docs readme fileMarti Bolivar2010-10-071-10/+15
|
* added skeleton sphinx docsMarti Bolivar2010-10-071-0/+220