diff --git a/doc/Makefile b/doc/Makefile index 9795b902..40920bbb 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -42,13 +42,13 @@ help: clean: -rm -rf $(BUILDDIR)/* -STATICS = _extensions/odoo_ext/static +STATICS = _extensions/flectra_ext/static # TODO: add bootstrap files LESSFILES = $(wildcard $(STATICS)/*.less) $(STATICS)/style.css: $(LESSFILES) $(LESSC) $(STATICS)/style.less $(STATICS)/style.css -html: _extensions/odoo_ext/static/style.css +html: _extensions/flectra_ext/static/style.css $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." diff --git a/doc/_extensions/autojsdoc/README.rst b/doc/_extensions/autojsdoc/README.rst index ef768177..c530f1d3 100644 --- a/doc/_extensions/autojsdoc/README.rst +++ b/doc/_extensions/autojsdoc/README.rst @@ -1,7 +1,7 @@ :orphan: ====================================== -JSDoc parser/Sphinx extension for Odoo +JSDoc parser/Sphinx extension for Flectra ====================================== Why? @@ -28,7 +28,7 @@ What? If it were possible to generate JSDoc annotations from our relatively well-defined code structures, it was obviously possible to extract documentary -information directly from it, hence this Odoo-specific package/extension +information directly from it, hence this Flectra-specific package/extension trying to do exactly that. This package should eventually provide: diff --git a/doc/_extensions/autojsdoc/parser/parser.py b/doc/_extensions/autojsdoc/parser/parser.py index d979170b..6a4d9ab5 100644 --- a/doc/_extensions/autojsdoc/parser/parser.py +++ b/doc/_extensions/autojsdoc/parser/parser.py @@ -13,9 +13,9 @@ DECLARATOR_INIT_TO_REF = ('Literal', 'Identifier', 'MemberExpression') class ModuleMatcher(Visitor): """Looks for structures of the form:: - odoo.define($string, function ($name) { + flectra.define($string, function ($name) { - These are *Odoo module definitions*, upon encountering one the + These are *Flectra module definitions*, upon encountering one the matcher: * creates a module entry, optionally associated with the module comment @@ -32,7 +32,7 @@ class ModuleMatcher(Visitor): # we're interested in expression statements (toplevel call) if utils.match(node, {'expression': { 'callee': { - 'object': {'name': 'odoo'}, + 'object': {'name': 'flectra'}, 'property': {'name': 'define'}, }, }}): @@ -191,9 +191,9 @@ BASE_SCOPE = BaseScope(None, { })), ] }), - 'odoo': jsdoc.UnknownNS({ - 'name': u'odoo', - 'doc': u"Odoo", + 'flectra': jsdoc.UnknownNS({ + 'name': u'flectra', + 'doc': u"Flectra", '_members': [ ('name', jsdoc.PropertyDoc({'name': u'csrf_token', 'type': u'{String}'})), ] diff --git a/doc/_extensions/autojsdoc/parser/tests/README.rst b/doc/_extensions/autojsdoc/parser/tests/README.rst index dd862bea..37ebbc91 100644 --- a/doc/_extensions/autojsdoc/parser/tests/README.rst +++ b/doc/_extensions/autojsdoc/parser/tests/README.rst @@ -1,6 +1,6 @@ :orphan: These files should be run via pytest_, simply install pytest and from the top -of the Odoo project run ``pytest doc/_extensions``. +of the Flectra project run ``pytest doc/_extensions``. .. _pytest: https://pytest.org/ diff --git a/doc/_extensions/autojsdoc/parser/tests/test_class.py b/doc/_extensions/autojsdoc/parser/tests/test_class.py index 403ae9b4..4f175e7c 100644 --- a/doc/_extensions/autojsdoc/parser/tests/test_class.py +++ b/doc/_extensions/autojsdoc/parser/tests/test_class.py @@ -6,7 +6,7 @@ from support import params, parse def test_classvar(): [mod] = parse(""" - odoo.define('a.A', function(require) { + flectra.define('a.A', function(require) { var Class = require('Class'); /** * This is my class-kai @@ -28,7 +28,7 @@ def test_classvar(): def test_classret(): [mod] = parse(""" - odoo.define('a.A', function(require) { + flectra.define('a.A', function(require) { var Class = require('Class'); /** * This is my class-kai @@ -46,7 +46,7 @@ def test_classret(): def test_methods(): [mod] = parse(""" - odoo.define('a.A', function(require) { + flectra.define('a.A', function(require) { var Class = require('Class'); return Class.extend({ /** @@ -92,7 +92,7 @@ def test_methods(): def test_mixin_explicit(): [mod] = parse(""" - odoo.define('a.A', function (require) { + flectra.define('a.A', function (require) { var Class = require('Class'); var mixins = require('mixins'); /** @@ -108,7 +108,7 @@ def test_mixin_explicit(): def test_mixin_implicit(): [mod] = parse(""" - odoo.define('a.A', function(require) { + flectra.define('a.A', function(require) { var Class = require('Class'); var Mixin = require('Mixin'); /** @@ -127,7 +127,7 @@ def test_mixin_implicit(): def test_instanciation(): [A, a] = parse(""" - odoo.define('A', function (r) { + flectra.define('A', function (r) { var Class = r('Class'); /** * @class A @@ -136,7 +136,7 @@ def test_instanciation(): foo: function () {} }); }); - odoo.define('a', function (r) { + flectra.define('a', function (r) { var A = r('A'); var a = new A; return a; @@ -147,7 +147,7 @@ def test_instanciation(): def test_non_function_properties(): [A] = parse(""" - odoo.define('A', function (r) { + flectra.define('A', function (r) { var Class = r('Class'); return Class.extend({ template: 'thing', @@ -163,7 +163,7 @@ def test_non_function_properties(): def test_non_extend_classes(): [mod] = parse(""" - odoo.define('A', function () { + flectra.define('A', function () { /** * @class */ @@ -175,11 +175,11 @@ def test_non_extend_classes(): def test_extend(): [a, _] = parse(""" - odoo.define('A', function (require) { + flectra.define('A', function (require) { var Class = require('Class'); return Class.extend({}); }); - odoo.define('B', function (require) { + flectra.define('B', function (require) { var A = require('A'); A.include({ /** A property */ @@ -203,7 +203,7 @@ def test_extend(): @pytest.mark.skip(reason="Need to implement member/var-parsing?") def test_members(): [mod] = parse(""" - odoo.define('A', function (r) { + flectra.define('A', function (r) { var Class = r('Class'); return Class.extend({ init: function () { diff --git a/doc/_extensions/autojsdoc/parser/tests/test_crap.py b/doc/_extensions/autojsdoc/parser/tests/test_crap.py index 70063e6d..c357fea8 100644 --- a/doc/_extensions/autojsdoc/parser/tests/test_crap.py +++ b/doc/_extensions/autojsdoc/parser/tests/test_crap.py @@ -1,6 +1,6 @@ # -*- coding: utf-8 -*- """ -Test various crap patterns found in Odoo code to ensure they don't blow up +Test various crap patterns found in Flectra code to ensure they don't blow up the parser thingie """ from autojsdoc.parser import jsdoc @@ -8,7 +8,7 @@ from support import parse def test_export_external(): [mod] = parse(""" - odoo.define('module', function () { + flectra.define('module', function () { return $.Deferred().reject(); }); """) @@ -17,7 +17,7 @@ def test_export_external(): def test_extend_jq(): parse(""" - odoo.define('a', function (r) { + flectra.define('a', function (r) { $.extend($.expr[':'], { a: function () {} }); $.fn.extend({ a: function () {} }); }); @@ -25,14 +25,14 @@ def test_extend_jq(): def test_extend_dynamic(): parse(""" - odoo.define('a', function () { + flectra.define('a', function () { foo.bar.baz[qux + '_external'] = function () {}; }); """) def test_extend_deep(): parse(""" - odoo.define('a', function () { + flectra.define('a', function () { var eventHandler = $.summernote.eventHandler; var dom = $.summernote.core.dom; dom.thing = function () {}; @@ -44,7 +44,7 @@ def test_extend_deep(): def test_arbitrary(): parse(""" - odoo.define('bob', function () { + flectra.define('bob', function () { var page = window.location.href.replace(/^.*\/\/[^\/]+/, ''); var mailWidgets = ['mail_followers', 'mail_thread', 'mail_activity', 'kanban_activity']; var bob; @@ -54,7 +54,7 @@ def test_arbitrary(): def test_prototype(): [A, B] = parse(""" - odoo.define('mod1', function () { + flectra.define('mod1', function () { var exports = {}; exports.Foo = Backbone.Model.extend({}); exports.Bar = Backbone.Model.extend({}); @@ -64,7 +64,7 @@ def test_prototype(): exports.Baz = Backbone.Model.extend({}); return exports; }); - odoo.define('mod2', function (require) { + flectra.define('mod2', function (require) { var models = require('mod1'); var _super_orderline = models.Bar.prototype; models.Foo = models.Bar.extend({}); diff --git a/doc/_extensions/autojsdoc/parser/tests/test_module.py b/doc/_extensions/autojsdoc/parser/tests/test_module.py index 2a63cc17..ea1425d3 100644 --- a/doc/_extensions/autojsdoc/parser/tests/test_module.py +++ b/doc/_extensions/autojsdoc/parser/tests/test_module.py @@ -9,7 +9,7 @@ def test_single(): /** * This is a super module! */ - odoo.define('supermodule', function (req) { + flectra.define('supermodule', function (req) { var other = req('other'); }); """) @@ -22,13 +22,13 @@ def test_single(): def test_multiple(): [mod1, mod2, mod3] = parse(""" - odoo.define('module1', function (req) { + flectra.define('module1', function (req) { return 1; }); - odoo.define('module2', function (req) { + flectra.define('module2', function (req) { return req('dep2'); }); - odoo.define('module3', function (req) { + flectra.define('module3', function (req) { var r = req('dep3'); return r; }); @@ -54,7 +54,7 @@ def test_multiple(): def test_func(): [mod] = parse(""" - odoo.define('module', function (d) { + flectra.define('module', function (d) { /** * @param {Foo} bar this is a bar * @param {Baz} qux this is a qux @@ -78,7 +78,7 @@ def test_func(): def test_hoist(): [mod] = parse(""" - odoo.define('module', function() { + flectra.define('module', function() { return foo; /** * @param a_thing @@ -95,7 +95,7 @@ def test_hoist(): def test_export_instance(): [mod] = parse(""" - odoo.define('module', function (require) { + flectra.define('module', function (require) { var Class = require('Class'); /** * Provides an instance of Class @@ -109,13 +109,13 @@ def test_export_instance(): def test_bounce(): [m2, m1] = parse(""" - odoo.define('m2', function (require) { + flectra.define('m2', function (require) { var Item = require('m1'); return { Item: Item }; }); - odoo.define('m1', function (require) { + flectra.define('m1', function (require) { var Class = require('Class'); var Item = Class.extend({}); return Item; @@ -129,7 +129,7 @@ def test_bounce(): def test_reassign(): [m] = parse(""" - odoo.define('m', function (require) { + flectra.define('m', function (require) { var Class = require('Class'); /** local class */ var Class = Class.extend({}); @@ -142,12 +142,12 @@ def test_reassign(): def test_attr(): [m1, m2] = parse(""" - odoo.define('m1', function (require) { + flectra.define('m1', function (require) { var Class = require('Class'); var Item = Class.extend({}); return {Item: Item}; }); - odoo.define('m2', function (require) { + flectra.define('m2', function (require) { var Item = require('m1').Item; Item.include({}); return Item.extend({}); @@ -159,14 +159,14 @@ def test_attr(): def test_nothing_implicit(): [m] = parse(""" - odoo.define('m', function () { + flectra.define('m', function () { }); """) assert m.exports is None def test_nothing_explicit(): [m] = parse(""" - odoo.define('m', function () { + flectra.define('m', function () { return; }); """) diff --git a/doc/_extensions/autojsdoc/parser/tests/test_namespace.py b/doc/_extensions/autojsdoc/parser/tests/test_namespace.py index 54cbcf8c..2e218ebc 100644 --- a/doc/_extensions/autojsdoc/parser/tests/test_namespace.py +++ b/doc/_extensions/autojsdoc/parser/tests/test_namespace.py @@ -5,7 +5,7 @@ from support import parse, params def test_empty(): [mod] = parse(""" - odoo.define('a.ns', function (r) { + flectra.define('a.ns', function (r) { return {}; }); """) @@ -14,7 +14,7 @@ def test_empty(): def test_inline(): [mod] = parse(""" - odoo.define('a.ns', function (r) { + flectra.define('a.ns', function (r) { return { /** * a thing @@ -31,7 +31,7 @@ def test_inline(): def test_header(): [mod] = parse(""" - odoo.define('a.ns', function (r) { + flectra.define('a.ns', function (r) { /** * @property {Boolean} a a thing */ @@ -45,7 +45,7 @@ def test_header(): def test_header_conflict(): """ should the header or the inline comment take precedence? """ [mod] = parse(""" - odoo.define('a.ns', function (r) { + flectra.define('a.ns', function (r) { /** * @property {Boolean} a a thing */ @@ -61,7 +61,7 @@ def test_header_conflict(): def test_mixin(): [mod] = parse(""" - odoo.define('a.mixin', function (r) { + flectra.define('a.mixin', function (r) { /** * @mixin */ @@ -81,7 +81,7 @@ def test_mixin(): def test_literal(): [mod] = parse(""" - odoo.define('a.ns', function (r) { + flectra.define('a.ns', function (r) { /** whop whop */ return { 'a': 1, @@ -97,7 +97,7 @@ def test_literal(): def test_fill_ns(): [mod] = parse(""" - odoo.define('a.ns', function (r) { + flectra.define('a.ns', function (r) { var Class = r('Class'); var ns = {}; /** ok */ @@ -120,14 +120,14 @@ def test_fill_ns(): def test_extend_other(): [o, b] = parse(""" - odoo.define('a.ns', function () { + flectra.define('a.ns', function () { /** @name outer */ return { /** @name inner */ a: {} }; }); - odoo.define('b', function (r) { + flectra.define('b', function (r) { var o = r('a.ns'); var Class = r('Class'); /** Class 1 */ @@ -151,7 +151,7 @@ def test_extend_other(): def test_ns_variables(): [mod] = parse(""" - odoo.define('A', function (r) { + flectra.define('A', function (r) { var Class = r('Class'); var Thing = Class.extend({}); return { @@ -166,7 +166,7 @@ def test_diff(): """ Have the NS key and the underlying object differ """ [mod] = parse(""" - odoo.define('mod', function (r) { + flectra.define('mod', function (r) { var Class = r('Class'); var Foo = Class.extend({}); return { Class: Foo }; diff --git a/doc/_extensions/odoo_ext/__init__.py b/doc/_extensions/flectra_ext/__init__.py similarity index 92% rename from doc/_extensions/odoo_ext/__init__.py rename to doc/_extensions/flectra_ext/__init__.py index 3cca5f7c..a8c1e94d 100644 --- a/doc/_extensions/odoo_ext/__init__.py +++ b/doc/_extensions/flectra_ext/__init__.py @@ -18,18 +18,18 @@ def setup(app): else: if getattr(app.config, 'html_translator_class', None): app.warn("Overriding the explicitly set html_translator_class setting", - location="odoo extension") - app.config.html_translator_class = 'odoo_ext.translator.BootstrapTranslator' + location="flectra extension") + app.config.html_translator_class = 'flectra_ext.translator.BootstrapTranslator' switcher.setup(app) - app.add_config_value('odoo_cover_default', None, 'env') - app.add_config_value('odoo_cover_external', {}, 'env') - app.add_config_value('odoo_cover_default_external', lambda conf: conf.odoo_cover_default, 'env') + app.add_config_value('flectra_cover_default', None, 'env') + app.add_config_value('flectra_cover_external', {}, 'env') + app.add_config_value('flectra_cover_default_external', lambda conf: conf.flectra_cover_default, 'env') app.connect('html-page-context', update_meta) def update_meta(app, pagename, templatename, context, doctree): meta = context.setdefault('meta', {}) - meta.setdefault('banner', app.config.odoo_cover_default) + meta.setdefault('banner', app.config.flectra_cover_default) def navbarify(node, navbar=None): """ diff --git a/doc/_extensions/odoo_ext/breadcrumb_list.html b/doc/_extensions/flectra_ext/breadcrumb_list.html similarity index 100% rename from doc/_extensions/odoo_ext/breadcrumb_list.html rename to doc/_extensions/flectra_ext/breadcrumb_list.html diff --git a/doc/_extensions/odoo_ext/layout.html b/doc/_extensions/flectra_ext/layout.html similarity index 60% rename from doc/_extensions/odoo_ext/layout.html rename to doc/_extensions/flectra_ext/layout.html index cb1015d2..586b6f88 100644 --- a/doc/_extensions/odoo_ext/layout.html +++ b/doc/_extensions/flectra_ext/layout.html @@ -54,7 +54,7 @@
- Start Now + Start Now
- Third party apps + Third party apps -
  • Tour
    • -
  • Pricing
    • -
  • Docs
    • +
  • Tour
    • +
  • Pricing
    • +
  • Docs