Commit Graph

29 Commits

Author SHA1 Message Date
Gabriel Pettier a59063e1f2 update doc template and travis.yml to use /doc/
for versionned documentation
2018-08-23 18:32:09 +02:00
Gabriel Pettier 89417c81be slight improvements to versions lookup & switch 2018-08-23 18:32:09 +02:00
Gabriel Pettier 4b97afa676 Maintain separate docs for different releases
This will cause CI to build docs for specific branches when they are
pushed to, and to copy the result into a subdirectory of the docs/
directory, instead of the root. The task will also update a
"versions.json" file, for the pages to be able to display/select other
versions.

The doc template is changed slightly to display a select field on top
of the quick search, using some js to fill the versions from the
generated versions.json file, and to change url when a different version
is selected.

This has been tested with a local server, trying to emulate the doc
structure, but the CI part hasn't been really tested.

Known Issues:

- the version.json file contains all versions configured to build, but
  the doc for these might not have been generated yet, which would
  result in 404 errors.
- the logic doesn't know if the current page of the doc exists for the
  selectable versions, so this will also result in 404 errors when
  switching to a version that didn't have the current doc page..
- the url manipulation logic is a bit dirty, as it assumes that the path
  is always of the form of /docs/<version>/….
- theming could certainly be slightly improved.
2018-08-23 18:32:09 +02:00
dessant 08ae6e1d29 update piwik script 2016-10-31 18:13:39 +02:00
dessant 4c49633c6d pdf builds are now managed by RTD 2016-09-04 10:16:06 +03:00
dessant dda3c911b0 Update layout.html 2016-01-05 13:35:10 +02:00
voen 3eb7f71e53 Enable twitter analytics for docs 2014-04-26 18:54:34 +03:00
Bastian Venthur 1b79083747 Replaced jquery-ui.min.js with uniminified versions.
Concatenated jquery.effects.core.js jquery.effects.slide.js from jquery 1.8.18
to one file and changed the original reference in layout.html to the new
filename.
2014-02-26 17:45:07 +01:00
qua-non 27a4adacdf doc: add wiki link at top 2013-10-11 16:54:41 +05:30
Mathieu Virbel f5cad6d905 doc: update layout and colors to integrate the garden. 2013-04-30 23:20:25 +02:00
Mathieu Virbel b7e6f54297 docs improvement: initial page is now gettingstarted/intro, avoid glitch when scrolling on the api, remove old files, and add color on the navtop menu. 2013-04-30 10:41:28 +02:00
Mathieu Virbel 414353cc08 doc: final modification, now need to test pdf 2013-04-14 14:44:01 +02:00
Mathieu Virbel 0b465bed27 doc: started style 2.0 2013-04-11 10:05:37 +02:00
Mathieu Virbel fd7864c74f doc: add the page TOP before the global TOC, and reorder this one with jquery to prevent inclusion of title twice.
+ add a little hook on window scroll to ensure the menu will stay on view.
2012-03-29 03:31:03 +02:00
Mathieu Virbel ae4f5ed070 doc: reintroduce tracking code for kivy docs 2012-03-26 01:44:52 +02:00
Mathieu Virbel 23b86fb55b doc/gettingstarted: first commit for the toolbar. handle #doc-<name>, keydown on left/right, and panel animation. 2012-03-21 20:26:40 +01:00
Mathieu Virbel 63f952bae4 enhance doc to add reflexion to all images 2012-03-17 02:08:47 +01:00
Mathieu Virbel 6c561401c8 doc: update logo 2012-01-25 13:29:57 +01:00
Mathieu Virbel 6a675b576b doc: update layout to be more usable and better integration with kivy website 2012-01-25 13:26:47 +01:00
Mathieu Virbel b9e493f5f0 doc: update docstyle to fit more in the current kivy.org design
+ enhance sidebar to support real table of content
+ various changes in the style / code to make a better doc (wip, as always)
2011-07-23 23:41:22 +02:00
Mathieu Virbel b1cb78470b doc: add download pdf link in sidebar for #192 2011-07-13 12:06:55 +02:00
Mathieu Virbel 7b1cb7bca0 doc: fix logo link to kivy.org, and remove the back to kivy.org link in menu. Closes #191 2011-07-13 12:01:07 +02:00
Mathieu Virbel 523db1bf89 doc: add previous/next link at the page bottom. Closes #84 2011-06-28 12:17:26 +02:00
Mathieu Virbel ed4de7ebd1 update documentation to move search box in header + toggle header 2011-01-31 22:11:41 +01:00
Mathieu Virbel 6fae223cb6 fix users guide link 2011-01-31 11:56:03 +01:00
Mathieu Virbel 0913ea946c Update documentation to fit the website theme 2011-01-31 03:06:59 +01:00
Mathieu Virbel a4e4f30dbe update doc css to include a sidebar 2010-12-22 12:14:24 +01:00
Mathieu Virbel 477a62a9eb update documentation generation 2010-12-16 20:18:30 +01:00
Mathieu Virbel 1f2fb6eb41 kivy: first import 2010-11-03 17:05:03 -04:00