<feed xmlns='http://www.w3.org/2005/Atom'>
<title>Odoo/doc/_extensions/autojsdoc/parser/jsdoc.py, branch 14.0</title>
<subtitle>The current checkout of upstream Odoo</subtitle>
<link rel='alternate' type='text/html' href='http://erp.ceuconsult.com:9000/Odoo/'/>
<entry>
<title>[MOV] doc: move documentation to a dedicated repository</title>
<updated>2021-05-04T08:09:20+00:00</updated>
<author>
<name>Victor Feyens</name>
<email>vfe@odoo.com</email>
</author>
<published>2021-04-30T13:24:57+00:00</published>
<link rel='alternate' type='text/html' href='http://erp.ceuconsult.com:9000/Odoo/commit/?id=27bad8c3e32049ec69a588df0558e57a0b928309'/>
<id>27bad8c3e32049ec69a588df0558e57a0b928309</id>
<content type='text'>
In odoo/documentation-user#945, the developer documentation is merged
with the user documentation in a single repository and build config.

This commit then removes source files for the developer documentation
from the odoo/odoo repository.

DOC PR: https://github.com/odoo/documentation-user/pull/945

task-2351938
task-2352371
task-2205684
task-2352544

Co-authored-by: Victor Feyens &lt;vfe@odoo.com&gt;
Co-authored-by: Antoine Vandevenne &lt;anv@odoo.com&gt;</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
In odoo/documentation-user#945, the developer documentation is merged
with the user documentation in a single repository and build config.

This commit then removes source files for the developer documentation
from the odoo/odoo repository.

DOC PR: https://github.com/odoo/documentation-user/pull/945

task-2351938
task-2352371
task-2205684
task-2352544

Co-authored-by: Victor Feyens &lt;vfe@odoo.com&gt;
Co-authored-by: Antoine Vandevenne &lt;anv@odoo.com&gt;</pre>
</div>
</content>
</entry>
<entry>
<title>[FIX] doc: workarounds for weirdo code &amp; refs</title>
<updated>2019-02-18T08:55:57+00:00</updated>
<author>
<name>Xavier Morel</name>
<email>xmo@odoo.com</email>
</author>
<published>2019-02-05T10:14:57+00:00</published>
<link rel='alternate' type='text/html' href='http://erp.ceuconsult.com:9000/Odoo/commit/?id=cca26f7952826601e9119478ac0edc30859d7f6a'/>
<id>cca26f7952826601e9119478ac0edc30859d7f6a</id>
<content type='text'>
Make UnknownNS more capable (of giving no fucks) so the documentation
builder blows up less on weird-ass code at module toplevels.

UnknownNS should probably be split out from NSDoc though, that requires
odd workarounds in `__getitem__`.</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
Make UnknownNS more capable (of giving no fucks) so the documentation
builder blows up less on weird-ass code at module toplevels.

UnknownNS should probably be split out from NSDoc though, that requires
odd workarounds in `__getitem__`.</pre>
</div>
</content>
</entry>
<entry>
<title>[FIX] doc: implement delegation/inheritance in JS documenter</title>
<updated>2018-10-01T15:31:41+00:00</updated>
<author>
<name>Xavier Morel</name>
<email>xmo@odoo.com</email>
</author>
<published>2018-10-01T15:25:59+00:00</published>
<link rel='alternate' type='text/html' href='http://erp.ceuconsult.com:9000/Odoo/commit/?id=00eefae98de7563b0c8018243ddf06482890fd51'/>
<id>00eefae98de7563b0c8018243ddf06482890fd51</id>
<content type='text'>
Else website_sale_wishlist.wishlist blows up the documenter:
``events`` is set to sAnimations.Class.events but that is not an "own
property" of sAnimation.Class, it is instead inherited from Widget.

If delegation is not implemented, the value resolves to &lt;nothing&gt;,
which blows up when trying to set its name to the "property name" (by
calling ``set_name``).
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
Else website_sale_wishlist.wishlist blows up the documenter:
``events`` is set to sAnimations.Class.events but that is not an "own
property" of sAnimation.Class, it is instead inherited from Widget.

If delegation is not implemented, the value resolves to &lt;nothing&gt;,
which blows up when trying to set its name to the "property name" (by
calling ``set_name``).
</pre>
</div>
</content>
</entry>
<entry>
<title>[FIX] doc building and warnings</title>
<updated>2018-08-27T10:55:21+00:00</updated>
<author>
<name>Xavier Morel</name>
<email>xmo@odoo.com</email>
</author>
<published>2018-08-27T10:55:21+00:00</published>
<link rel='alternate' type='text/html' href='http://erp.ceuconsult.com:9000/Odoo/commit/?id=0e307f8280eda4343a63c7faa2d52e33d46c9c0c'/>
<id>0e307f8280eda4343a63c7faa2d52e33d46c9c0c</id>
<content type='text'>
doc:

* fix incorrect doc comments (documenting params which don't exist)
* correctly quote non-refs
* fix role label syntax (backticks must be escaped)
* add newline to fix warning

JS doc parser:

* fix handling of already-resolved objects
* fix handling of non-string properties (e.g. foo[0] at module toplevel)
* don't blow up if subject of .include call can't be resolved (just ignore)

Others:

* add translator support for ``problematic`` node (apparently used for
  some refs by recent Sphinx)
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
doc:

* fix incorrect doc comments (documenting params which don't exist)
* correctly quote non-refs
* fix role label syntax (backticks must be escaped)
* add newline to fix warning

JS doc parser:

* fix handling of already-resolved objects
* fix handling of non-string properties (e.g. foo[0] at module toplevel)
* don't blow up if subject of .include call can't be resolved (just ignore)

Others:

* add translator support for ``problematic`` node (apparently used for
  some refs by recent Sphinx)
</pre>
</div>
</content>
</entry>
<entry>
<title>[FIX] various broken JS docstrings</title>
<updated>2018-07-24T10:06:13+00:00</updated>
<author>
<name>Xavier Morel</name>
<email>xmo@odoo.com</email>
</author>
<published>2018-07-24T10:06:13+00:00</published>
<link rel='alternate' type='text/html' href='http://erp.ceuconsult.com:9000/Odoo/commit/?id=a56372a4caa8b716ac0a4c36b3265ddce2d7b8d1'/>
<id>a56372a4caa8b716ac0a4c36b3265ddce2d7b8d1</id>
<content type='text'>
Resulting in sphinx warnings or ill-formatted doc all the way to the
doc not building at all.
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
Resulting in sphinx warnings or ill-formatted doc all the way to the
doc not building at all.
</pre>
</div>
</content>
</entry>
<entry>
<title>[FIX] doc: informal sub-params</title>
<updated>2018-01-10T11:36:58+00:00</updated>
<author>
<name>Xavier Morel</name>
<email>xmo@odoo.com</email>
</author>
<published>2018-01-10T11:32:54+00:00</published>
<link rel='alternate' type='text/html' href='http://erp.ceuconsult.com:9000/Odoo/commit/?id=f7323dbe2321558f96640d6643a8b593958d8a49'/>
<id>f7323dbe2321558f96640d6643a8b593958d8a49</id>
<content type='text'>
Revert 6cb12273e2c1e1385098e38880317ae162dc902e which reverted
08d48b0fff0938e7ac004767dddfab13d3cff30b.

Issue was the support for sub-parameters (aka @param {type} foo.bar)
where the "parent" parameter was not formal (only present in a
function's docstring, but not in the function's parameters list),
subtype creation would fail to find a root parameter to attach the
sub-parameter to.

This has not actually been fixed, but for the specific case where the
formal parameters list is *completely empty* we fall back on a list of
the docstring's parameters, which works well enough for this case.
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
Revert 6cb12273e2c1e1385098e38880317ae162dc902e which reverted
08d48b0fff0938e7ac004767dddfab13d3cff30b.

Issue was the support for sub-parameters (aka @param {type} foo.bar)
where the "parent" parameter was not formal (only present in a
function's docstring, but not in the function's parameters list),
subtype creation would fail to find a root parameter to attach the
sub-parameter to.

This has not actually been fixed, but for the specific case where the
formal parameters list is *completely empty* we fall back on a list of
the docstring's parameters, which works well enough for this case.
</pre>
</div>
</content>
</entry>
<entry>
<title>[FIX] building documentation with P3</title>
<updated>2017-10-10T11:29:11+00:00</updated>
<author>
<name>Xavier Morel</name>
<email>xmo@odoo.com</email>
</author>
<published>2017-10-10T11:29:11+00:00</published>
<link rel='alternate' type='text/html' href='http://erp.ceuconsult.com:9000/Odoo/commit/?id=40ca8557e9e25832afa40afd84124319cb71f87b'/>
<id>40ca8557e9e25832afa40afd84124319cb71f87b</id>
<content type='text'>
* fix P3 incompatibilities in doc/_extensions
* vendor pyjsdoc, strip out everything we're not using and make what's
  left P3-compatible (upstream is not P3 compliant)
* drop undeclared dependency on attrs as it turns out not to be much
  used
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
* fix P3 incompatibilities in doc/_extensions
* vendor pyjsdoc, strip out everything we're not using and make what's
  left P3-compatible (upstream is not P3 compliant)
* drop undeclared dependency on attrs as it turns out not to be much
  used
</pre>
</div>
</content>
</entry>
<entry>
<title>[ADD] doc: JS document extraction system</title>
<updated>2017-09-18T09:54:36+00:00</updated>
<author>
<name>Xavier Morel</name>
<email>xmo@odoo.com</email>
</author>
<published>2017-09-18T08:13:54+00:00</published>
<link rel='alternate' type='text/html' href='http://erp.ceuconsult.com:9000/Odoo/commit/?id=313f69e9487e991e4db33c75682342b185da5c73'/>
<id>313f69e9487e991e4db33c75682342b185da5c73</id>
<content type='text'>
* Fix a bunch of ill-documented/incomplete/incorrect method docs
* add start of Sphinx extension to extract &amp; 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 &amp;
    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
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
* Fix a bunch of ill-documented/incomplete/incorrect method docs
* add start of Sphinx extension to extract &amp; 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 &amp;
    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
</pre>
</div>
</content>
</entry>
</feed>
