e3fee2cf46
Prior to this commit, the Odoo documentation was mainly split between
two repositories: odoo/odoo/doc and odoo/documentation-user. Some bits
of documentation were also hosted elsewhere (e.g., wiki, upgrade, ...).
This was causing several problems among which:
- The theme, config, Makefile, and similar technical resources had to
be duplicated. This resulted in inconsistent layout, features, and
build environments from one documentation to another.
- Some pages did not fit either documentation as they were relevant
for both users and developers. Some were relevant to neither of the
two (e.g., DB management).
- Cross-doc references had to be absolute links and they broke often.
- Merging large image files in the developer documentation would bloat
the odoo/odoo repository. Some contributions had to be lightened to
avoid merging too many images (e.g., Odoo development tutorials).
- Long-time contributors to the user documentation were chilly about
going through the merging process of the developer documentation
because of the runbot, mergebot, `odoo-dev` repository, etc.
- Some contributors would look for the developer documentation in the
`odoo/documentation-user` repository.
- Community issues about the user documentation were submitted on the
`odoo/odoo` repository and vice-versa.
Merging all documentations in one repository will allow us to have one
place, one theme, one work process, and one set of tools (build
environment, ...) for all of the Odoo docs.
As this is a good opportunity to revamp the layout of the documentation,
a brand new theme replaces the old one. It features a new way to
navigate the documentation, centered on the idea of always letting the
reader know what is the context (enclosing section, child pages, page
structure ...) of the page they are reading. The previous theme would
quickly confuse readers as they navigated the documentation and followed
cross-application links.
The chance is also taken to get rid of all the technical dangling parts,
performance issues, and left-overs. Except for some page-specific JS
scripts, the Odoo theme Sphinx extension is re-written from scratch
based on the latest Sphinx release to benefit from the improvements and
ease future contributions.
task-2351938
task-2352371
task-2205684
task-2352544
Closes #945
119 lines
3.6 KiB
Python
119 lines
3.6 KiB
Python
"""
|
|
* adds github_link(mode) context variable: provides URL (in relevant mode) of
|
|
current document on github
|
|
* if sphinx.ext.linkcode is enabled, automatically generates github linkcode
|
|
links (by setting config.linkcode_resolve)
|
|
|
|
Settings
|
|
========
|
|
|
|
* ``github_user``, username/organisation under which the project lives
|
|
* ``github_project``, name of the project on github
|
|
* (optional) ``version``, github branch to link to (default: master)
|
|
|
|
Notes
|
|
=====
|
|
|
|
* provided ``linkcode_resolve`` only supports Python domain
|
|
* generates https github links
|
|
* explicitly imports ``odoo``, so useless for anyone else
|
|
"""
|
|
|
|
import inspect
|
|
import importlib
|
|
import os.path
|
|
import werkzeug
|
|
|
|
|
|
def setup(app):
|
|
app.add_config_value('github_user', None, 'env')
|
|
app.add_config_value('github_project', None, 'env')
|
|
app.connect('html-page-context', add_doc_link)
|
|
|
|
def linkcode_resolve(domain, info):
|
|
""" Resolves provided object to corresponding github URL """
|
|
# TODO: js?
|
|
if domain != 'py':
|
|
return None
|
|
if not (app.config.github_user and app.config.github_project):
|
|
return None
|
|
|
|
module, fullname = info['module'], info['fullname']
|
|
# TODO: attributes/properties don't have modules, maybe try to look
|
|
# them up based on their cached host object?
|
|
if not module:
|
|
return None
|
|
|
|
obj = importlib.import_module(module)
|
|
for item in fullname.split('.'):
|
|
obj = getattr(obj, item, None)
|
|
|
|
if obj is None:
|
|
return None
|
|
|
|
# get original from decorated methods
|
|
try:
|
|
obj = getattr(obj, '_orig')
|
|
except AttributeError:
|
|
pass
|
|
|
|
try:
|
|
obj_source_path = inspect.getsourcefile(obj)
|
|
_, line = inspect.getsourcelines(obj)
|
|
except (TypeError, IOError):
|
|
# obj doesn't have a module, or something
|
|
return None
|
|
|
|
import odoo
|
|
# FIXME: make finding project root project-independent
|
|
project_root = os.path.join(os.path.dirname(odoo.__file__), '..')
|
|
return make_github_link(
|
|
app,
|
|
os.path.relpath(obj_source_path, project_root),
|
|
line,
|
|
odoo_repository=True)
|
|
app.config.linkcode_resolve = linkcode_resolve
|
|
|
|
return {
|
|
'parallel_read_safe': False,
|
|
'parallel_write_safe': True
|
|
}
|
|
|
|
def make_github_link(app, path, line=None, mode="blob", odoo_repository=False):
|
|
config = app.config
|
|
|
|
user = config.github_user
|
|
project = config.github_project
|
|
if odoo_repository:
|
|
user = 'odoo'
|
|
project = 'odoo'
|
|
|
|
urlpath = "/{user}/{project}/{mode}/{branch}/{path}".format(
|
|
user=user,
|
|
project=project,
|
|
branch=config.version or 'master',
|
|
path=path,
|
|
mode=mode,
|
|
)
|
|
return werkzeug.urls.url_unparse((
|
|
'https',
|
|
'github.com',
|
|
urlpath,
|
|
'',
|
|
'' if line is None else 'L%d' % line
|
|
))
|
|
|
|
|
|
def add_doc_link(app, pagename, templatename, context, doctree):
|
|
""" Add github_link function linking to the current (.rst) page on github """
|
|
if not app.config.github_user and app.config.github_project:
|
|
return
|
|
|
|
# FIXME: find other way to recover current document's source suffix
|
|
# in Sphinx 1.3 it's possible to have mutliple source suffixes and that
|
|
# may be useful in the future
|
|
source_suffix = app.config.source_suffix
|
|
source_suffix = next(iter(source_suffix))
|
|
context['github_link'] = lambda mode='edit': make_github_link(
|
|
app, 'content/%s%s' % (pagename, source_suffix), mode=mode)
|