documentation
documentation copied to clipboard
odoo
[IMP] accounting: improved bank reconciliation page
The previous documentation was based on V13 which did not feature the "In Payment" status.
Task ID: task - 2869193
Nice job @toaa-odoo ! @jcs-odoo the page name 'use_cases.rst' doesn't really fit the content anymore. Could we change it to something more relevant? (or we avoid changing rst file names?
It seems you decided to update the .rst file name. If you do that, you need to change several elements in the documentation.
Here are the relevant warnings I got when I did make clean html:
\documentation\content\applications\finance\accounting\bank\reconciliation.rst:7: WARNING: toctree contains reference to nonexisting document 'applications/finance/accounting/bank/reconciliation/use_cases'
\documentation\content\applications\finance\accounting\bank\reconciliation\bank_reconciliation.rst: WARNING: document isn't included in any toctree
You are first warned that in the reconciliation.rst file, the use_cases.rst is referenced in its table of content (toctree). The toctree is used to list all the .rst files that are located underneath a .rst file. The second warning tells you that bank_reconciliation.rst isn't referenced anywhere.
How to fix both warnings at the same time: on line 10 of the reconciliation.rst, replace reconciliation/use_cases.rst with reconciliation/bank_reconciliation.rst.
\documentation\content\applications\finance\accounting\bank\reconciliation\reconciliation_models.rst:127: WARNING: unknown document: use_cases
\documentation\content\applications\finance\accounting\fiscal_localizations\localizations\mexico.rst:547: WARNING: unknown document: ../../bank/reconciliation/use_cases
\documentation\content\applications\finance\accounting\others\multicurrencies\exchange.rst:112: WARNING: unknown document: ../../bank/reconciliation/use_cases
\documentation\content\applications\finance\accounting\payables\pay\multiple.rst:100: WARNING: unknown document: ../../bank/reconciliation/use_cases
\documentation\content\applications\finance\accounting\payables\pay\sepa.rst:136: WARNING: unknown document: ../../bank/reconciliation/use_cases
Those five warnings come from broken references/links to use_cases.rst in other .rst files. You have to update them. For example, on line 127 of reconciliation_models.rst, change - :doc:`use_cases` to - :doc:`bank_reconciliation.rst`
Then, there is one last thing you should do (when you move/remove/rename pages and content) that doesn't generate any warning when using make html. You need to add a redirect in the redirects.txt file (found under the main documentation folder). Everything is explained in the file, but simply, you need to add the path to the previous file, a space, and the path to the new file - everything on the same line at the end of the .txt file. ~Note: the full path isn't always necessary,~ but maybe @AntoineVDV can better explain from which point the path needs to start?
@xpl-odoo The full path is always necessary! Some redirect rules might be misleading because they were added back when the structure of the documentation was different from what it is today. So, the rule should start with "application/".
Not in line with what was expected. Will probably be redone when overall documentation structure has been revised. No need for this PR.