mirror of
https://github.com/odoo/documentation.git
synced 2026-01-02 17:59:20 +07:00
44cddcf090
task-5094417
This commit rewrites the Taxes page. Previously, it came across as a
huge list of tax configuration options. We now structure it as follows:
1. an overview of the tax flow in Odoo;
2. a set-up guide for taxes for new users;
3. an explanation of the most common configuration options.
The options related to the tax computation are split into a separate
Tax Computation page, in which we also improve the following sections:
- Tax computations:
At the moment, the section for the `Percentage of Price tax included`
tax computation doesn't distinguish itself enough from the 'Included
in Price' option which people usually want.
We also improve the examples.
- Included in Price
- Affects base of subsequent taxes
- Base affected by preceding taxes: this option was not documented, so
we add a section for it.
Ultimately, we plan to rewrite the Tax Computation page to provide a
better explanation of how the tax computation actually works, and be
more helpful at guiding the user to configure their taxes.
X-original-commit: 0f4aa202de
Odoo documentation
Build the documentation
Requirements
- Git
- Python 3.10 to 3.14.
- Make
- Python dependencies from
requirements.txt(see instructions below) - A local copy of the odoo/odoo repository (optional)
- A local copy of the odoo/upgrade-util repository (optional)
Quick start
- Create and activate a virtual environment.
- On Linux and macOS:
python3 -m venv .venv && source .venv/bin/activate - On Windows (PowerShell):
py3 -m venv .venv; .\.venv\Scripts\Activate.ps1
- On Linux and macOS:
- Install the Python dependencies:
pip install -r requirements.txt - Build the documentation:
make html(see more commands withmake help) - Open
documentation/_build/html/index.htmlin your web browser.
Additional build options
make fastto build the documentation with a shallow menu (faster).make cleanto delete the build files.make testto run the guidelines tests.make html CURRENT_LANG=frto build the documentation only in French.make html CURRENT_LANG=fr LANGUAGES=en,fr,deto build the documentation in French and enable the language switcher, with the specified LANGUAGES as available languages. This command must be invoked for each CURRENT_LANG you want to build.make html VERSIONS=17.0,18.0,saas-18.4,19.0,masterto build the documentation in the current version and enable the version switcher, with the specified VERSIONS as available versions. This command must be invoked for each of the VERSIONS you want to build.
The list of available languages can be found in conf.py, in the languages_names variable.
When building the documentation for a specific language or version, the build files are created in
documentation/_build/html/<language>/, documentation/_build/html/<version>/ or
documentation/_build/html/<version>/<language>/.
Using local Odoo sources
If you have local checkouts of odoo/odoo and/or odoo/upgrade-util, place them either:
- as siblings of this repository (in the parent directory), or
- inside the
documentationdirectory.
When present in one of these locations, the build will include Python docstrings from those repositories if their version matches the documentation's version.
Troubleshooting
- Verify your Python version:
python3 --version(must be 3.10–3.14) - Ensure your virtual environment is active and dependencies are installed.
- If you have made changes to the file structure, try
make cleanbefore building. - If the language or version switchers redirect to a missing file, check that you have built the documentation for all available languages and versions.
- The "Developer" documentation is only available in English.
Contribute to the documentation
For contributions to the content of the documentation, see the Introduction Guide.
To report a content issue, request new content, or ask a question, use the issue tracker.