This commit is part of a larger work to improve the documentation's
structure. The toctree structure used to add levels to create categories
and make the structure visually more understandable.
With the new version of the documentation, plenty of these categories
are now redundant.
Since other docs were moved away from the section "basics" with previous
commits, this category is renamed "users settings"
This commit:
- renames "basics" into "users settings"
- moves the content from "odoo_basics/users" to "users"
- it moves the content about "access rights" to a child doc
task-2535899
This commit is part of a larger work to improve the documentation's
structure. The toctree structure used to add levels to create categories
and make the structure visually more understandable.
With the new version of the documentation, plenty of these categories
are now redundant.
This commit:
- removes the main "settings" section
- move its content to general/odoo_basics
- moves "general/mobile" content to "general"
- moves the content of the doc "developer_mode/activate" to "general"
- it replaces the references to that doc with `:ref:` directives
rather than `:doc:` directives
- it is worth noting that it also fixes plenty of links that
previously referred to "developer_mode" (the category) rather than
"developer_mode/activate" (the document)
task-2535899
This commit is part of a larger work to improve the documentation's
structure. The toctree structure used to add levels to create categories
and make the structure visually more understandable.
With the new version of the documentation, plenty of these categories
are now redundant.
This commit merges all docs about data import/export into a single doc:
- base_import/import_faq -> export_import_data
- base_import/adapt_template -> export_import_data
- odoo_basics/export-data -> export_import_data
task-2535899
This commit is part of a larger work to improve the documentation's
structure. The toctree structure used to add levels to create categories
and make the structure visually more understandable.
With the new version of the documentation, plenty of these categories
are now redundant.
This commit merges all docs about unsplash into a single doc:
- "unsplash/unsplash_access_key" -> unsplash
- "unsplash/unsplash_application_id" -> unsplash
task-2535899
This commit is part of a larger work to improve the documentation's
structure. The toctree structure used to add levels to create categories
and make the structure visually more understandable.
With the new version of the documentation, plenty of these categories
are now redundant.
This commit improves the structure of the "general" section:
- moves the content of "payment_acquirers/payment_acquirers" to its
parent page, as main content for this category.
It also improves the content of the note about sensitive data.
task-2535899
This commit is part of a larger work to improve the documentation's
structure. The toctree structure used to add levels to create categories
and make the structure visually more understandable.
With the new version of the documentation, plenty of these categories
are now redundant.
This commit improves the structure of the "general" section:
- it moves the content of the doc "in_app_purchase" to its parent page
"multi_companies"
- it moves the content of the doc "tags/take_tags" to "odoo_basics/tags"
- it moves the content of the doc "manage_multi_companies" to its parent
page "multi_companies"
task-2535899
This commit is part of a larger work to improve the documentation's
structure. The toctree structure used to add levels to create categories
and make the structure visually more understandable.
With the new version of the documentation, plenty of these categories
are now redundant.
This commit:
- renames "expense" to "expenses" as it is in the app and in the title
- restructures the files
- moves the media files from "media" folder to "expenses" folder
- adds a short intro to expenses
task-2535899
This commit is part of a larger work to improve the documentation's
structure. The toctree structure used to add levels to create categories
and make the structure visually more understandable.
With the new version of the documentation, plenty of these categories
are now redundant.
This commit improves the structure of the "Accounting" app:
- it moves the doc "in-odoo" in the top "app" level and its content is
included in "accounting.rst" (the content will later be improved)
- adds new intro
- changes external links to mementos to correct doc references
- it renames the category accounting/overview to
accounting/getting_started
- it renames the category accounting/overview/getting_started to
accounting/getting_started/initial_configuration
- it moves "memento" one level above, from
accounting/overview/main_concepts to the renamed
accounting/getting_started as it is the last doc remaining in this
category
- it renames the app "Invoicing and Accounting" to
"Accounting and Invoicing" since the focus should be on "Accounting"
task-2535899
This commit is part of a larger work to improve the documentation's
structure. The toctree structure used to add levels to create categories
and make the structure visually more understandable.
With the new version of the documentation, plenty of these categories
are now redundant.
This commit improves the structure of the "Sign" app:
- it removes a useless "overview" category
- it adds a brief explanation at the "app" level, including links to
relevant docs
task-2535899
Removes unnecessary, straightforward, easy-to-figure out documentation, as part of an effort to '
clear out any sort of documentation that is either too easy, too simple,
or already gone over in the tutorial videos. This documentation falls into that category. Hence,
it was removed entirely.
As per the documentation, it is possible to show inventory availability under ecommerce without
installing Inventory app which is incorrect. Made the appropriate changes.
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
