summaryrefslogtreecommitdiff
path: root/doc/conf.py
AgeCommit message (Collapse)Author
2019-02-18[IMP] doc: PYTHONPATH configurationXavier Morel
Previously we'd `append` the extensions and odoo parent directories to sys.path, however this means if an `odoo` is already installed in a sys.path (e.g. global installation, or setup.py develop in a venv, ...) *that* will be used as the source of Python code (for autodoc) instead of the Python source being synchronised with the rst, which can lead to very odd behaviour. Prepend the doc's stuff to the PYTHONPATH instead, to ensure they get priority and the code matching the rst gets loaded.
2019-01-25[MERGE] forward port branch saas-11.3 up to 387d5cff90bChristophe Simonis
closes odoo/odoo#30566
2019-01-21[REM] doc: outdated intersphinx mappingsXavier Morel
ea6e7379a35e91f9ad064e5ad1e87c5177ea067b removed the few intersphinx refs to sqlalchemy & django, so these mappings have not been necessary in a year. This is especially annoying as the currently configured sqlalchemy mapping has been very flaky / regularly failing. Remove the mappings entirely. closes odoo/odoo#30397
2018-09-26[FIX] doc: set version for version dropdownMartin Trigaux
The version number is used in the version dropdown in the the switcher_list.html file as well as in the page title
2018-04-19[FIX] doc: correct doc versionMartin Trigaux
As now published at https://www.odoo.com/documentation/master/
2017-10-12[FIX] doc: variousXavier Morel
* fix Sphinx 1.6 compatibility leading to the "tiles" on the home page not working anymore: 1.6 replaces BuildEnvironment.reolve_toctree by TocTree().resolve(), while the method still exists it's not actually called anymore * rejigger some CSS as the second section went from one big tile to 3 smaller tiles, and got laid out as a row rather than a second 2x2 block. Recode the entire mess with flexbox, remove some stuff which conflicted with boostrap (this screen should probably be de-boostrapped and completely converted to flexbox or grid) * add building CSS from LESS to the makefile, all Odoo devs should have less installed locally (for assets)
2017-10-11[FIX] doc: update to version 11Martin Trigaux
Use python 3.5 Refer to correct page of the doc Remove old bazar to git (was intended for the 8.0) Remove outdated setup_dev script: it was intended for odoo developers but if you are not able to make a git clone, you are going to have a bad time later.
2017-09-18[ADD] doc: JS document extraction systemXavier Morel
* Fix a bunch of ill-documented/incomplete/incorrect method docs * add start of Sphinx extension to extract & integrate jsdoc into Sphinx documentation: - parse JS files (and don't blow up), uses a fork of pyjsparser as the project currently does not parse comments - extract cross-module dependency information - parse JsDoc comments using pyjsdoc and infer structure from code & jsdoc - ``ast`` CLI printing a simplified AST of the input files - ``dependencies`` creating a dependency graph of either all modules in the provided input files or the modules matching the specified filters (warning: will not work if missing dependencies), generates a .dot file - ``extractor`` generating a plain text module documentation (mix of rst and markdown styles, not anything formal) * sphinx extension with an "automodule" directive taking a module name and generating the documentation for it
2017-06-16[REM] doc: remove the accounting memento from technical docMartin Trigaux
Will be moved to odoo/documentation-user repository cf task id 34230
2016-10-11[FIX] doc: avoid conflict on extenstion and odoo folderMartin Trigaux
2016-09-22[FIX] doc: rename current branch name in configurationMartin Trigaux
It is used in the version switcher
2015-07-10[MERGE] forward port of branch 8.0 up to 9654b54Christophe Simonis
2015-07-08[FIX] doc: new theme snagsXavier Morel
* fix handling of no banner (and no default banner) on documents: - don't try to build a banner URL at the top of document - don't build a mini-banner in cards * fix compatibility between custom HTML translator and domains creating new nodes (and their rendering): hook translator via app.add_translator so app.add_node can do the job correctly: with html_translator_class the application is not aware of the new HTML translator and add_node can't add the relevant rendering methods * add translation for line_block and line (classes not used, point is just to have a div for each line so "newlines" are kept
2015-07-07[MERGE] forward port of branch 8.0 up to 2de301dChristophe Simonis
2015-07-07[ADD] doc: new themeXavier Morel
Pretty much completely rewritten theme with custom HTML translator and a few parts of the old theme extracted to their own extensions. Banner images thought not to be that huge after all, and not worth the hassle of them living in a different repository. co-authored with @stefanorigano
2015-04-13[MERGE] forward port of branch 8.0 up to 8ac8281Christophe Simonis
2015-04-09[IMP] fix links to business mementoesXavier Morel
* 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)
2014-12-31[REF] remove vim modelines and resulting trailing blank linesLeonardo Donelli
Let 2015 be a year without modelines! cf #4174
2014-12-02[MERGE] forward port of branch 8.0 up to 591e329Christophe Simonis
2014-11-24[CHG] doc: company officially renamedXavier Morel
2014-11-18[MERGE] forward port of branch 8.0 up to 5ed0739Jeremy Kersten
2014-11-17[FIX] doc: latex buildingXavier Morel
* 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-05[MERGE] forward port of branch 8.0 up to 491372eChristophe Simonis
2014-10-31[IMP] doc: add link to company website in footer, fix release versionXavier Morel
2014-10-29[MERGE] forward port of branch 8.0 up to 92c7874Christophe Simonis
2014-10-29[ADD] doc: support for analytics keysXavier Morel
2014-10-21[MERGE] forward port of branch 8.0 up to 262eb66Christophe Simonis
2014-10-20[ADD] doc: basic index page instead of something completely blankXavier Morel
2014-10-16[MERGE] forward port of branch 8.0 up to 2b192beChristophe Simonis
2014-10-07[FIX] sphinx 'project' valueXavier Morel
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[ADD] port webclient RPC doc from web/docXavier Morel
2014-10-01[FIX] doc: branch name in configurationxmo-odoo
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[REVERT] typoxmo-odoo
2014-10-01[FIX] doc: branch name in configurationxmo-odoo
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-09-04[ADD] support for a version switcher in odoo theme thingXavier Morel
needs beauty input
2014-09-04[ADD] doc's readmeXavier Morel
* also only enable linkcode if Sphinx >= 1.2 * fix html inline roles?
2014-09-03[ADD] support for canonical urls in technical docXavier Morel
* 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[ADD] github links from docXavier Morel
2014-09-01[ADD] openerp.http reference docXavier Morel
* fix some docstrings so they can be autodoc'd * intersphinx mapping (and links to) werkzeug and python
2014-08-22[ADD] doc: new documentation, with training tutorials, and new scaffoldingRaphael Collet
2014-05-19[CHG] remove flask theme, add sphinx-bootstrap 0.3.8Xavier Morel
2014-05-19[ADD] tutorial beginningXavier Morel
blocked at introducing qweb template, ir.qweb lives in the registry but nodb -> no database with --db-filter there's a database in the session (kinda) but need to fetch it and manually get the corresponding registry...
2014-01-16[FIX] somebody renamed classes without fixing the corresponding autodoc ↵Xavier Morel
invocation bzr revid: xmo@openerp.com-20140116144957-j2no6ls83vfxtgbk
2013-01-04[IMP] To hell with global doc.Vo Minh Thu
bzr revid: vmt@openerp.com-20130104134955-dpf9792ng2gqani3
2012-10-06rm files, move postload hookAntony Lesuisse
bzr revid: al@openerp.com-20121006171053-qggp1r5263h7v7vd
2012-10-02[FIX] versions and class names in docXavier Morel
bzr revid: xmo@openerp.com-20121002135053-0br6kzif8tmarltp
2012-04-24[IMP] get started on doc for VS-less searchviewXavier Morel
bzr revid: xmo@openerp.com-20120424160759-aghh2pzioy1k4yw4
2012-03-05[DOC] change v6.1 reference to trunk.Openerp Online
bzr revid: online@openerp.com-20120305164617-2ykj6o263sywjstz
2012-03-05[DOC] change v6.1 reference to trunk.Openerp Online
bzr revid: online@openerp.com-20120305164552-tij9m4if82h4huts
2012-03-05[DOC] use a flat (i.e. no source/ directory) structure.Openerp Online
bzr revid: online@openerp.com-20120305124016-d25rncl3q2qcem31