Commit Graph

526 Commits

Author SHA1 Message Date
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
ged-odoo 817ce8f912 [IMP] add link to write method in documentation 2014-11-14 14:38:15 +01:00
Xavier Morel e7b6d0bda9 [ADD] doc: guide to the new API
Raw API documentation is not sufficient for people to learn the working
principles of the API, especially when they already know the old one. And some
things have changed since the opendays so the presentations don't reflect the
current state of affairs.

Closes #3483
2014-11-07 14:42:33 +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 06a75d0e95 [FIX] doc: typo missed when merging contribution 2014-11-05 17:12:46 +01:00
hiekmann d6cfd8ed4b [IMP] doc: various improvements to website tutorial
closes #3476
closes #3477
closes #3479
2014-11-05 16:42:19 +01:00
Xavier Morel 03e9a38a1d [IMP] doc: remove guides section, move themes to tutorials and rest to reference
also pass PNGs through crusher, turns out dot produces pretty terrible PNGs
2014-11-03 17:39:24 +01:00
Xavier Morel a332dec4c2 [IMP] doc: add some diagrams to workflow doc
Also move transitions to the bottom of the document, and try to clarify the
documentation for split, join and activity kinds.
2014-11-03 14:55:09 +01:00
Xavier Morel 45d649e44d [FIX] doc: graph <field> does not use :grouping
see #3403 and 7ad4af8
2014-11-03 13:02:33 +01:00
Xavier Morel a8959295da [CHG] doc: promote individual view types to document toplevel 2014-11-03 13:02:32 +01:00
Nicolas Bustillos d0ff6df2f4 [FIX] doc: fit code example to new API
When using this code as is, the 'ids' variable throws an exception for not
being defined. In the new API, 'ids' is no longer given as a function variable
but as a variable within 'self'.

close #3406
2014-11-03 10:19:30 +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
Christophe Matthieu 1dcc1c62cc [FIX] doc website: application field does not exists on ir.ui.view. The optional inherit used customize_show and active fields 2014-10-22 10:46:38 +02:00
Richard Mathot d80376a43d [DOC] cmdline: database-related parameters 2014-10-21 10:07:54 +02:00
Xavier Morel ed18ab7649 [ADD] doc: basic index page instead of something completely blank 2014-10-20 10:00:20 +02:00
Tymoteusz Motylewski 2b8cb4fa89 [ADD] doc: document domain operators, fix typos
* Add description for all allowed operators.
* Improve wording of domain documentation and fix spelling.
2014-10-14 11:14:06 +02:00
Xavier Morel d7f2cc2483 [REM] undocument removed method add_default_value 2014-10-14 11:12:57 +02:00
Tymoteusz Motylewski 902506ad28 fix typo 2014-10-13 10:42:30 +02:00
Xavier Morel bc59cfce61 [IMP] doc: add testing reference and improve docstrings 2014-10-09 15:38:36 +02:00
Xavier Morel 9501f33d1d [ADD] doc: workflow doc from v7+ (saas-5)
I tried starting a better one, but the workflow code is a complete mess so I
have no idea how this thing works without significant study and testing.

Thus, not trying to write a brand new and complete doc, maybe later.
2014-10-09 13:37:15 +02:00
Xavier Morel 5d64577f57 [ADD] actions documentation 2014-10-08 17:29:35 +02:00
Xavier Morel 9cd2693286 [FIX] JS tutorial 2014-10-07 10:23:50 +02:00
Xavier Morel 393331f948 [FIX] sphinx 'project' value
The project name automatically gets the release and the literal string
"documentation" appended by default (and "html_title" can be set to generate a
title differently), so having "documentation" set in the project variable
duplicates it in the page title.
2014-10-07 10:22:53 +02:00
Xavier Morel 62c9589485 [ADD] port webclient RPC doc from web/doc 2014-10-07 10:22:53 +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 5954335222 [ADD] pyqweb-specific stuff, pyqweb APIDoc 2014-10-06 19:13:46 +02:00
Xavier Morel d5e3d121e3 [ADD] qweb: call directive's body
* __content__ can't be used in Python implementation because safe_eval, so use
  ``0`` from Python implementation instead
* remove postfix from t-call tests because due to implementation details all
  whitespace crap following a t-name is added to rendered template in Python
  impl, and don't want to normalize whitespace.
2014-10-06 19:13:45 +02:00
Xavier Morel 494dcbd0e3 [IMP] qweb doc, tests
* document qweb based (mostly) on JS version
* convert JS qweb tests to (mostly) language-independent XML so they can be
  used for JS and Python implementations
* add some more tests (e.g. precedence between t-value and body in t-set)
* remove ``t-import``
* fix parity in foreach(dict) (and rename some variables to make array and
  object versions more similar)
2014-10-06 19:13:43 +02:00
Martin Trigaux 7ba9174bce [ADD] contribution files and image removed at 2ad092b 2014-10-02 12:05:32 +02:00
xmo-odoo e7422b2f3a [REVERT] typo 2014-10-01 15:19:20 +02:00
xmo-odoo a1eacb9054 [FIX] doc: branch name in configuration
The branch name is used in the version switcher, so the master branch should have a version of "master".

Maybe the release could be the revision hash? Not sure how to extract it from the repo.
2014-10-01 15:02:20 +02:00
xmo-odoo c85547477c [FIX] doc readme: the list of versions uses commas
it's not space-separated
2014-09-29 13:40:10 +02:00
Raphael Collet 7190bb7886 [IMP] doc/backend: add example using jsonrpclib 2014-09-09 10:12:00 +02:00
Xavier Morel c5fbb47abf [ADD] doc: model inheritance stuff 2014-09-09 09:19:32 +02:00
Raphael Collet 7be175bad6 [IMP] doc/backend: add example for JSON-RPC interaction 2014-09-08 17:16:10 +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
Xavier Morel eab52acccd [ADD] initial theme guide + scaffolding
incomplete, incorrect, committed for testing
2014-09-02 12:43:17 +02:00
Xavier Morel 9c339d8df3 [ADD] web client tutorial/training
needs fixes, and corresponding web client reference
2014-09-01 14:16:15 +02:00