[MERGE] Forward-port of branch 12.0 to 13.0

This commit is contained in:
Antoine Vandevenne (anv) 2021-05-12 18:26:22 +02:00
commit 7b01bf417c
7 changed files with 97 additions and 101 deletions

50
README.md Normal file
View File

@ -0,0 +1,50 @@
# Odoo documentation
## Build the documentation locally
### Requirements
- [Git](https://www.odoo.com/documentation/13.0/contributing/documentation/introduction_guide.html#install-git)
- [Python 3.6, 3.7, or 3.8](https://www.odoo.com/documentation/13.0/contributing/documentation/introduction_guide.html#python)
- Python dependencies listed in the file [`requirements.txt`](https://github.com/odoo/documentation/tree/13.0/requirements.txt).
- [Make](https://www.odoo.com/documentation/13.0/contributing/documentation/introduction_guide.html#make)
- A local copy of the [odoo/odoo repository in 13.0](https://github.com/odoo/odoo/tree/13.0) (Optional)
### Instructions
1. In a terminal, navigate to the root directory and compile the documentation to HTML with the
following command:
```sh
make
```
Additional commands are available with `make help`.
2. Open the file `documentation/_build/html/index.html` in your web browser to display the render.
3. See [this guide](https://www.odoo.com/documentation/13.0/contributing/documentation/introduction_guide.html#preview-your-changes)
for more detailed instructions.
Optional: to fully build the developer documentation with inline docstrings for documented Python
functions, place your local copy of the `odoo/odoo` repository in the root directory. Alternatively,
create a symbolic link with `odoo` as link name. If the Odoo sources are not found, a warning will
be shown.
## Contribute to the documentation
For contributions to the content of the documentation, please refer to the
[Introduction Guide](https://www.odoo.com/documentation/13.0/contributing/documentation/introduction_guide.html).
To **report a content issue**, **request new content** or **ask a question**, use the
[repository's issue tracker](https://github.com/odoo/documentation-user/issues) as usual.
If you have a pull request that is ready for review, request one from the
[odoo/doc-review](https://github.com/orgs/odoo/teams/doc-review) team.
## Learn More
To learn more about Odoo, in addition to the documentation, have a look at
[the official eLearning](https://odoo.com/slides) and
[Scale-up, The Business Game](https://www.odoo.com/page/scale-up-business-game).

View File

@ -1,54 +0,0 @@
===========================
End-user Odoo documentation
===========================
Build the documentation
=======================
Requirements
------------
- `Git <https://www.odoo.com/documentation/user/contributing/documentation/introduction_guide.html#install-git>`_
- | `Python 3 <https://www.odoo.com/documentation/user/contributing/documentation/introduction_guide.html#python>`_
| If you don't know which subversion to choose, pick the last one.
| Python dependencies are listed in the file ``requirements.txt`` located in the root
directory.
- Sphinx 2.4.0 or above.
- Werkzeug 0.14.1
- `Make <https://www.odoo.com/documentation/user/contributing/documentation/introduction_guide.html#make>`_
Instructions
------------
In a terminal, navigate to the root directory and execute the following command:
.. code-block:: console
$ make html
This compiles the documentation to HTML.
Open ``documentation-user/_build/html/index.html`` in your web browser to display the render.
See `this guide
<https://www.odoo.com/documentation/user/contributing/documentation/introduction_guide.html#prepare-your-version>`_
for more detailed instructions.
Contribute to the documentation
===============================
For contributions to the content of the documentation, please refer to the `Introduction Guide
<https://www.odoo.com/documentation/user/contributing/documentation/introduction_guide.html>`_.
To **report a content issue**, **request new content** or **ask a question**, use the `repository's
issue tracker <https://github.com/odoo/documentation-user/issues>`_ as usual.
Learn More
==========
To learn more about Odoo, in addition to the documentation, have a look at `the official eLearning
<https://odoo.com/slides>`_ and `Scale-up, The Business Game
<https://www.odoo.com/page/scale-up-business-game>`_

View File

@ -9,12 +9,6 @@ This introductory guide will help you acquire the tools and knowledge you need t
documentation, whether you plan to make a minor content change or document an application from documentation, whether you plan to make a minor content change or document an application from
scratch. scratch.
.. note::
This tutorial only concerns the `user documentation
<https://www.odoo.com/documentation/user/index.html>`_ of Odoo. The documentation for `developing
in Odoo <https://www.odoo.com/documentation/master/index.html>`_ is maintained alongside the
source code of Odoo at `github.com/odoo/odoo <https://github.com/odoo/odoo/tree/master/doc>`_.
.. _contributing/rst-intro: .. _contributing/rst-intro:
reStructuredText reStructuredText
@ -75,10 +69,10 @@ Use the GitHub interface
.. image:: media/edit-on-github.png .. image:: media/edit-on-github.png
#. If you do not have edit rights on the repository (`odoo/documentation-user #. If you do not have edit rights on the repository (`odoo/documentation
<https://github.com/odoo/documentation-user>`_), you need to fork it by clicking on the <https://github.com/odoo/documentation>`_), you need to fork it by clicking on the appropriate
appropriate button. In other terms, you create a copy of the entire repository on your own button. In other terms, you create a copy of the entire repository on your own account. If you do
account. If you do have the edit rights, skip this step. have the edit rights, skip this step.
.. image:: media/fork-repository.png .. image:: media/fork-repository.png
@ -111,7 +105,7 @@ Use the GitHub interface
.. image:: media/select-branches-base.png .. image:: media/select-branches-base.png
#. Double-check your :abbr:`PR (Pull Request)` and, when ready, click again on the **Create pull #. Double-check your :abbr:`PR (Pull Request)` and, when ready, click again on the **Create pull
request** button to submit your changes for review by a redactor at Odoo. request** button to submit your changes for review by a content writer at Odoo.
.. image:: media/create-pull-request.png .. image:: media/create-pull-request.png
@ -158,15 +152,15 @@ Fetch the sources
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
As stated earlier, our documentation (in all its versions) is maintained on GitHub at As stated earlier, our documentation (in all its versions) is maintained on GitHub at
`github.com/odoo/documentation-user <https://github.com/odoo/documentation-user>`_. A modification `github.com/odoo/documentation <https://github.com/odoo/documentation>`_. A modification is made by
is made by the mean of a :abbr:`PR (Pull Request)` (:dfn:`proposal of content changes`) to allow for the mean of a :abbr:`PR (Pull Request)` (:dfn:`proposal of content changes`) to allow for a review
a review of the changes before updating the sources of the documentation. of the changes before updating the sources of the documentation.
Prior to submitting a modification, you need to make a copy of the sources and download that copy on Prior to submitting a modification, you need to make a copy of the sources and download that copy on
your machine. your machine.
#. Go to `github.com/odoo/documentation-user <https://github.com/odoo/documentation-user>`_ and #. Go to `github.com/odoo/documentation <https://github.com/odoo/documentation>`_ and click on the
click on the **Fork** button in the top right corner. **Fork** button in the top right corner.
.. image:: media/fork-button.png .. image:: media/fork-button.png
@ -174,8 +168,8 @@ your machine.
.. code-block:: console .. code-block:: console
$ git clone https://github.com/odoo/documentation-user $ git clone https://github.com/odoo/documentation
$ cd documentation-user/ $ cd documentation/
.. important:: .. important::
If you do not have edit rights on the repository owned by Odoo, replace "odoo" with your If you do not have edit rights on the repository owned by Odoo, replace "odoo" with your
@ -190,7 +184,7 @@ your machine.
.. code-block:: doscon .. code-block:: doscon
$ cd documentation-user/ $ cd documentation/
$ git config --global core.autocrlf true $ git config --global core.autocrlf true
$ git config commit.template %CD%\commit_template.txt $ git config commit.template %CD%\commit_template.txt
@ -198,7 +192,7 @@ your machine.
.. code-block:: console .. code-block:: console
$ cd documentation-user/ $ cd documentation/
$ git config --global core.autocrlf input $ git config --global core.autocrlf input
$ git config commit.template `pwd`/commit_template.txt $ git config commit.template `pwd`/commit_template.txt
@ -221,7 +215,8 @@ Python comes with its own package manager: `pip
<https://en.wikipedia.org/wiki/Pip_(package_manager)>`_. It allows installing Python dependencies in <https://en.wikipedia.org/wiki/Pip_(package_manager)>`_. It allows installing Python dependencies in
a single command. a single command.
#. Download and install the latest release of **Python 3** on your machine. #. Download and install the recommended release (`see README file
<https://github.com/odoo/documentation/tree/13.0/README.md>`_) of **Python 3** on your machine.
#. Make sure to have **pip** installed on your machine (on Windows, you can install pip alongside #. Make sure to have **pip** installed on your machine (on Windows, you can install pip alongside
Python). Python).
#. Execute the following commands in a terminal to verify that both installations finished #. Execute the following commands in a terminal to verify that both installations finished
@ -237,7 +232,7 @@ a single command.
.. code-block:: console .. code-block:: console
$ cd documentation-user/ $ cd documentation/
$ pip3 install -r requirements.txt $ pip3 install -r requirements.txt
.. note:: .. note::
@ -288,7 +283,7 @@ Execute the following commands in a terminal to...
.. code-block:: console .. code-block:: console
$ cd documentation-user/ $ cd documentation/
#. Switch to the version 13.0: #. Switch to the version 13.0:
@ -337,7 +332,7 @@ To preview your changes in a generated documentation, proceed as follows:
.. code-block:: console .. code-block:: console
$ cd documentation-user/ $ cd documentation/
$ make clean $ make clean
$ make html $ make html
@ -346,7 +341,7 @@ To preview your changes in a generated documentation, proceed as follows:
hierarchy of documentation files. hierarchy of documentation files.
#. Fix any error or warning shown in the logs of the build. #. Fix any error or warning shown in the logs of the build.
#. Open the file :file:`documentation-user/_build/html/index.html` with your default web browser. #. Open the file :file:`documentation/_build/html/index.html` with your default web browser.
.. note:: .. note::
These steps have for only purpose to show you the final results of your changes. They have no These steps have for only purpose to show you the final results of your changes. They have no
@ -372,9 +367,8 @@ Submit your changes
$ git commit $ git commit
$ git push -u origin 13.0-my_contribution $ git push -u origin 13.0-my_contribution
#. Go to `github.com/odoo/documentation-user/pulls #. Go to `github.com/odoo/documentation/pulls
<https://github.com/odoo/documentation-user/pulls>`_ and click on the **New pull request** <https://github.com/odoo/documentation/pulls>`_ and click on the **New pull request** button.
button.
.. image:: media/new-pull-request.png .. image:: media/new-pull-request.png

View File

@ -21,21 +21,24 @@ Given the following source file tree:
:: ::
documentation-user documentation
├── sales ├── content
│ └── products_prices │ └── applications
│ │ └── products │ │ └── sales
│ │ │ └── import.rst │ │ │ └── sales
│ │ │ └── variants.rst │ │ │ │ └── products_prices
│ │ └── prices.rst │ │ │ │ │ └── products
│ │ │ │ │ │ └── import.rst
│ │ │ │ │ │ └── variants.rst
│ │ │ │ │ └── prices.rst
A reference to the rendered :file:`prices.html` and :file:`variants.html` could be made from A reference to the rendered :file:`prices.html` and :file:`variants.html` could be made from
:file:`import.rst` as follows: :file:`import.rst` as follows:
#. Absolute: #. Absolute:
- ``https://odoo.com/documentation/user/13.0/sales/products_prices/prices.html`` - ``https://odoo.com/documentation/13.0/applications/sales/sales/products_prices/prices.html``
- ``https://odoo.com/documentation/user/13.0/sales/products_prices/products/variants.html`` - ``https://odoo.com/documentation/13.0/applications/sales/sales/products_prices/products/variants.html``
#. Relative: #. Relative:

View File

@ -91,10 +91,6 @@
{%- set main_classes = main_classes + ['o_fullwidth_page'] %} {%- set main_classes = main_classes + ['o_fullwidth_page'] %}
{%- endif %} {%- endif %}
<div class="px-3 py-4 d-lg-none">
<!-- Searchbox only visible in mobile -->
{%- include "layout_templates/searchbox.html" %}
</div>
<main class="container-fluid {{ ' '.join(main_classes) }}"> <main class="container-fluid {{ ' '.join(main_classes) }}">
{%- if pagename == master_doc %} {%- if pagename == master_doc %}
{# Custom landing page on the root of the documentation #} {# Custom landing page on the root of the documentation #}

View File

@ -1,6 +1,5 @@
{# NOTE: the 'searchbox' id is used to hook the "Hide Search Matches" button #} {# NOTE: the 'searchbox' id is used to hook the "Hide Search Matches" button #}
{# NOTE: currently renamed to '_searchbox' to hide the button until it receives proper styling #} <div id="searchbox" class="o_search_wrapper flex-grow-1 pe-lg-2" role="search">
<div id="_searchbox" class="o_search_wrapper flex-grow-1 justify-content-stretch justify-content-lg-start pe-lg-2" role="search">
<form class="o_search" action="{{ pathto('search') }}" method="get"> <form class="o_search" action="{{ pathto('search') }}" method="get">
<input type="text" name="q" id="q" class="form-control rounded-pill" placeholder="What are you looking for?"> <input type="text" name="q" id="q" class="form-control rounded-pill" placeholder="What are you looking for?">
<input type="hidden" name="area" value="default"> <input type="hidden" name="area" value="default">

View File

@ -72,17 +72,22 @@ header.o_main_header{
} }
} }
.o_search_wrapper { .o_search_wrapper {
display: flex;
@include media-breakpoint-down(lg) { @include media-breakpoint-down(lg) {
display: none !important; display: block;
position: absolute;
width: 100%;
padding: 0 10px;
top: calc(100% + 30px);
} }
} }
.highlight-link { .highlight-link {
margin-bottom: 0; margin-bottom: 0;
display: flex; padding: 0 1rem;
align-items: center; text-align: center;
align-self: center;
a { a {
padding: 0 1rem;
@include font-size($font-size-secondary); @include font-size($font-size-secondary);
} }
} }
@ -369,6 +374,9 @@ header.o_main_header{
main { main {
position: relative; position: relative;
padding-top: 3rem; padding-top: 3rem;
@include media-breakpoint-down(lg) {
padding-top: 7rem;
}
padding-bottom: 3rem; padding-bottom: 3rem;
@include media-breakpoint-up(lg) { @include media-breakpoint-up(lg) {