Commit Graph

39 Commits

Author SHA1 Message Date
Xavier Morel bbe1845727 [FIX] doc: extra underline for document titles when document has no introductory blurb 2015-04-22 11:50:47 +02:00
Xavier Morel a6493f77af [IMP] fix links to business mementoes
* rename functional -> business
* fix navbarification of main toctree: would stop processing after it
  hit the first toc item without children, and the business links (with
  children) follow the web service toc item (without children)
2015-04-09 10:29:38 +02:00
Xavier Morel 4cba11a7d4 [FIX] ws doc: table border colors in right column
Table borders remained the same color as in the "light" half, an overly
bright gray (#ddd) on a very dark background rather than a very light
gray on a white background.

Convert to a shade of dark gray lighter than the background, but nowhere
near as light as the text itself.
2015-03-11 14:46:50 +01:00
Xavier Morel 8bc89de4d6 [IMP] ws doc: selectivity of the highlight right-alignment 2015-03-09 09:53:00 +01:00
Xavier Morel e700805a43 [FIX] ws doc: language switcher in some iOS versions 2015-02-26 11:47:07 +01:00
Xavier Morel f24df6a93c [FIX] ws doc: fix DOM order for copy/paste usability
The toggle button for the setup code in code examples of the webservice
page was mistakenly inserted between the setup code and the "actual"
code in the DOM. Trying to select the whole snippet (including setup)
would thus also select the text of the button and copy it to the
clipboard, breaking the copied code and confusing users.

Fix DOM order so selecting setup and actual code does not include the
text of the toggle button.
2015-02-20 10:26:13 +01:00
Xavier Morel 06b037b558 [IMP] doc: some systems choke on bare URL in CSS imports 2015-02-18 11:37:10 +01:00
Xavier Morel eac831f45b [IMP] doc: allow force-right sections, removing bootstrap class from tables 2015-02-16 09:44:33 +01:00
Xavier Morel 2140ead305 [IMP] doc: support disabling sidebar 2015-02-03 15:46:14 +01:00
Xavier Morel 4a4d3a60bb [IMP] doc: simplify webservice api doc
* remove ZeroClipboard, pain to test locally and deployment didn't work
  right due to needing absolute path to the swf always
* remove the clipboard alteration on the fly, behaves oddly and can be
  confusing
* add an explicit button to expand and collapse the setup content
* fixup some styling
2015-01-19 15:36:26 +01:00
Xavier Morel 085e8e49c1 [FIX] doc: fetch font over https 2014-12-02 14:23:28 +01:00
Xavier Morel c0997c7877 [FIX] ws doc: copy button in columned version 2014-12-02 14:23:27 +01:00
Xavier Morel 8e9c23235a [IMP] ws doc: affix language switcher to page top 2014-11-27 16:37:27 +01:00
Xavier Morel 39d77f9e85 [FIX] doc: viewport meta missing 2014-11-27 16:37:27 +01:00
Xavier Morel 2cfd7182cc [CHG] ws doc: set right section against a dark background 2014-11-27 16:37:26 +01:00
Xavier Morel f90dd77fff [FIX] doc: double period in footer 2014-11-18 11:18:14 +01:00
Xavier Morel 5ed0739e73 [FIX] doc: latex building
* add latex support for exercise admonition
* latex freezes/crashes on {HEAVY WIDE-HEADED RIGHTWARDS ARROW} so
  replace them by more manual arrows
* add some preamble configuration, may not even be necessary
* generate WS setup code only in HTML output. WS doc in latex still
  isn't great as it displays all 4 languages one after the other,
  ideally they should be tagged or something, so only one language at a
  time is generated in non-HTML outputs
2014-11-17 17:43:26 +01:00
Xavier Morel a4d2f04564 [IMP] doc: have ws page take whole page width
Doc pages used container() which is width-limited, works acceptably for
single-column content but WS page takes 2 columns with code, having as
much space as possible is a much better idea.

Mayhaps it should even use lg-column(2) instead of md-column(3)?
2014-11-17 16:20:43 +01:00
Xavier Morel 8f784edce1 [IMP] doc: rename WS page, lift to top-level 2014-11-17 16:10:50 +01:00
Xavier Morel c65ed4df76 [IMP] doc: more indexy index 2014-11-17 15:10:34 +01:00
Xavier Morel f302c123ea [IMP] doc: indexify index
* opt-in toc navification
* unhide index toctree, it's now back to a list of documents
* remove text thing
2014-11-17 14:07:36 +01:00
Xavier Morel 166ddc98a9 [FIX] allow word wrapping in stripe-style code examples 2014-11-07 14:13:15 +01:00
Xavier Morel 5d79dd80e5 [ADD] ZeroClipboard-based "copy" button on snippets
Also fix ruby setup code, some of its bits were actually Python and didn't
quite work when pasted into irb...
2014-11-07 14:01:32 +01:00
Xavier Morel 6f0b1fef4d [IMP] doc-ws: prepend setup code when copying from a snippet 2014-11-07 11:32:43 +01:00
Xavier Morel 95265e9ba6 [IMP] doc: link directly to edition mode in docfiles 2014-10-31 09:34:55 +01:00
Xavier Morel 63e1afc5fd [IMP] doc: add link to company website in footer, fix release version 2014-10-31 09:34:55 +01:00
Xavier Morel 55737d6500 [IMP] doc: link logo to current doc's root, not to odoo.com 2014-10-31 09:34:54 +01:00
Xavier Morel 28a69fa250 [ADD] doc: support for analytics keys 2014-10-29 15:53:41 +01:00
Xavier Morel abfe20bff6 [ADD] doc: language switcher 2014-10-27 17:23:16 +01:00
Xavier Morel 4d2b24adcb [ADD] Stripe-style APIDoc: content 2014-10-27 17:23:16 +01:00
Xavier Morel ed18ab7649 [ADD] doc: basic index page instead of something completely blank 2014-10-20 10:00:20 +02:00
Xavier Morel 62fcce9054 [ADD] JS widgets reference documentation
Also fixed Widget#alive's behavior and tested it
2014-10-07 10:21:44 +02:00
Xavier Morel 2232453760 [IMP] doc: move version switcher to header
as recommended by nwi

use same style as logo but very slightly smaller font, otherwise the
difference is a bit jarring as numbers are much bigger than the app logo's
text
2014-09-04 16:24:56 +02:00
Xavier Morel bb007dd040 [ADD] support for a version switcher in odoo theme thing
needs beauty input
2014-09-04 14:43:55 +02:00
Xavier Morel 39208e1f42 [ADD] doc's readme
* also only enable linkcode if Sphinx >= 1.2
* fix html inline roles?
2014-09-04 14:43:54 +02:00
Xavier Morel 958f9106dd [ADD] support for canonical urls in technical doc
* canonical_root setting is the path to the root of the canonical sphinx doc,
  if not set no canonical link is generated, must end with "/"
* canonical_branch defines the canonical branch to which to redirect, defaults
  to master

also various side-fixes:

* disabled permalinks in sphinx instead of hiding them via CSS
* improved generation of github links, removed _app global and setting of
  linkcode_resolve in conf.py
2014-09-03 16:34:52 +02:00
Xavier Morel f00bf9a461 [ADD] github links from doc 2014-09-03 14:53:41 +02:00
Xavier Morel c0373318d9 [IMP] display sibling documents in affixed menu 2014-09-03 14:53:40 +02:00
Raphael Collet 2ad092b5e5 [ADD] doc: new documentation, with training tutorials, and new scaffolding 2014-08-22 17:51:20 +02:00