mirror of
https://github.com/odoo/documentation.git
synced 2025-12-12 07:29:27 +07:00
7825baa743
As of version 19.0 the UX and business logic of the purchase suggestion feature of the product catalog has changed slightly: UX changes: - Not a wizard anymore, suggest is now accessed via the left sidebar in catalog (screenshot and text updated) Business logic: - Suggestion are only for the warehouse indicated on the PO (vs before having a dropdown input to select the warehouse). - Suggestions now, therefore, include internal transfers to to other warehouses. Additionally, I made clearer that suggestions take into account existing stock on hand (by adding a step in math formula) and that the feature is only activated for draft RFQ and does not estimate demand from non-draft RFQ or MOs. closes odoo/documentation#15368 Signed-off-by: Jean Schoenlaub (jesc) <jesc@odoo.com>
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.