v 12.0 Third Party 76
Required Apps Website (website)
Included Dependencies
Lines of code 10963
Technical Name documentation_builder
LicenseSee License tab
Also available in version v 15.0 v 13.0 v 16.0 v 14.0
You bought this module and need support? Click here!
Required Apps Website (website)
Included Dependencies
Lines of code 10963
Technical Name documentation_builder
LicenseSee License tab
Also available in version v 15.0 v 13.0 v 16.0 v 14.0

Clear and full documentation is a way to highlight seriousness of your project, to cut costs by motivating clients for self-service, and to reveal hidden organizational knowledge. However, creating and, more important, supporting documentation site is a complex task. This tools aims to help with that.

With KnowSystem you gradually prepare materials which might be already used as a shared online library. Simultaneously, navigating by independent articles becomes harder, and you decide to combine knowledge into chapters. The idea is to have a single documentation website page which fully covers a definite issue or aspect. The app Odoo Documentation Builder let you efficiently achieve that goal.

This is an extension to the tool KnowSystem: Knowledge Base System. Read the full description of the features and optional modules on the core module page.

Structured and Customizable Documentation

The tool allows preparing an unlimited number of documentation pages structured by categories. You can also modify appearance of pages: show or hide introductions and footers, turn on/off search bar and table of contents, add or remove preview images and texts. Comfortable for navigation, easy to maintain.

Simple to Prepare and Update

To create a new documentation section just select and order KnowSystem articles. The app would generate a website page automatically. Moreover, each article revision would be reflected on this page on a fly, while to update this documentation set you need just to add or to remove an article.

Dynamic Navigation

Table of contents for documentation is constructed automatically according to article headers. In such a way, end users might navigate to a target documentation piece in a single click. Moreover, when a visitor scrolls a page, navigation panel dynamically shows where she/he is now. The feature might be turned off at any moment.

The easiest and most beautiful way to add content

The document builder is a great tool to add content to your website. It has a clean, well organized interface and adding content is super easy. I can highly recommend it! And very important to know too: The support of faOtools is great. Nice people that care and that go a long way to make sure you get the tool you need.

-- Eisberger

Inline Search

To address very specific aspects, end users often would require inspecting materials for definite key words. The tool covers that case by introducing the optional search bar inside each documentation page. It is possible to find matches in a whole text or only in headers, to make key words case sensitive or insensitive.

Documentation Versioning

When you prepare specifications, user manuals or software guidelines, you inevitable face the situation when certain articles are suitable only for definite product versions. Simultaneously, the most of materials are fine for all versions. To avoid double work in such a case, the app let indicate to which version an article relates to. Thus, only topical materials would be shown.

Documentation Security

Documentation categories and sections are designed for a shared use, although you at any moment can restrict both portal and public accesses on the configuration page. Each category or section might be unpublished, for example, for the period of re-construction. Besides, it is possible to limit particular documentation page for chosen portal partners using KnowSystem tags (in the same way it is done for articles). The latter allows you, for instance, to sell valuable materials.
Access to articles (documentation parts) is regulated by the app KnowSystem, where you can manage rights for public and portal users. This tool, however, let you overcome this regulation by selecting a security action. In particular, it is possible to fully neglect access rights (always show an article disregarding rights), show warning if no access is possible (good for paid access for materials), or use standard approach (articles would not be shown at all for limited users; so documentation would look differently for different users).

Multi Websites

The tool supports multi website environment. In particular, it is possible to show/hide documentation pages for definite sites, to have different categories for different portals, and to have own settings per each platform.

According to the current Odoo Apps Store policies:

  • every module bought for the version 12.0 and prior gives you an access to the all versions up to 12.0.
  • starting from the version 13.0, every version of the module should be purchased separately.
  • disregarding the version, purchasing a tool grants you a right for all updates and bug fixes within a major version.

Take into account that faOtools team does not control those policies. By all questions please contact the Odoo Apps Store representatives directly.

The easiest approach is to use the Odoo store built-in workflow:

1. Open the module's page and click the button Deploy on odoo.sh

2. After that, you will be redirected to the GitHub page. Login to your account and click 'Create a new repo' or use the existing one. Please, make sure, that your repository is private. It is not permitted to publish the apps under the OPL-1 license. If necessary, create a new repo for your Odoo.sh project

3. Then, go to odoo.sh and click on the deploy button, submit the decision in the pop-up window and click 'Continue'. The action will trigger the installation process.

These steps would install the app for your project production branch. If you wanted to deploy the apps for other branches or update the module, you should undertake the following actions:

1. Upload the source code for the app from the Odoo store

2. Commit the module to a required GitHub repository. Make sure that none of the app folders/files are ignored (included in the .gitignore of your repo). Repositories are automatically created by odoo.sh, which might add by default some crucial items there (e.g. /lib). You should upload all module directories, subdirectories, and files without exceptions

3. Deploy a target branch of the odoo.sh project or wait until it is automatically built if your settings assume that.

  1. Unzip the source code of the purchased tools in one of your Odoo add-ons' directories;

  2. Re-start the Odoo server;

  3. Turn on the developer mode (technical settings);

  4. Update the apps' list (the apps' menu);

  5. Find the app and push the button 'Install';

  6. Follow the guidelines on the app's page if those exist.

Yes, sure. Take into account that Odoo automatically adds all dependencies to a cart. You should exclude previously purchased tools.

A red/orange warning itself does not influence features of the app. Regretfully, sometimes our modules do not pass standard automatic tests, since the latter assumes behavior which is in conflict with our apps goals. For example, we change price calculation, while standard Odoo module tests compare final price to standard algorithm.

So, first of all, please check deployed database features. Does everything work correctly?

If you still assume that warning influences real features, please contact us and forward full installation logs and the full lists of deployed modules (including core and third party ones).

Regretfully, we do not have a technical possibility to provide individual prices.

No, third party apps can not be used on Odoo Online.

Yes, all modules marked in dependencies are absolutely required for a correct work of our tool. Take into account that price marked on the app page already includes all necessary dependencies.  

The price for our modules is set up in euros. The Odoo store converts prices in others currencies according to its internal exchange rate. Thus, the price in US Dollars may change, when exchange rate changes.

Bug reporting

In case you have faced any bugs or inconsistent behavior, do not hesitate to contact us. We guarantee to provide fixes within 60 days after the purchase, while even after this period we are strongly interested to improve our tools.

To send us a bug report: press the "Website" link on the top of this page and push the button "Bug Report" (the tab Support). Alternatively, copy the link https://faotools.com/s/n6qpz5

No phone number or credit card is required to contact us: only a short email sign up which does not take more than 30 seconds.

Please include in your request as many details as possible: screenshots, Odoo server logs, a full description of how to reproduce your problem, and so on. Usually, it takes a few business days to prepare a working plan for an issue (if a bug is confirmed) or provide you with guidelines on what should be done (otherwise).

Public features requests and module ideas (free development)

We are strongly motivated to improve our tools and would be grateful for any sort of feedback. In case your requirements are of public use and might be efficiently implemented, the team would include those in our to-do list.

Such a to-do list is processed on a regular basis and does not assume extra fees. Although we cannot promise deadlines and final design, it might be a good way to get desired features without investments and risks.

To share ideas: press the "Website" link on the top of this page and push the button "Share Features Ideas" (the tab Support). Alternatively, copy the link https://faotools.com/s/oondr7

No phone number or credit card is required to contact us: only a short email sign up which does not take more than 30 seconds.

Questions and misc issues

Feel free to contact us with any other concerns, doubts, or questions: press the "Website" link on the top of this page and push the button "Raise Question" (the tab Support). Alternatively, copy the link https://faotools.com/s/p1kj8e

About the team

faOtools (faotools.com, former odootools.com) is the team of developers and business analysts to help you extend Odoo's potential. We have been communicating with end users to whom the software became the main business tool since 2012. As a result, we are proud of dozens of successful Odoo apps developed. We are open for new ideas and challenges to create the best Odoo apps for business needs all over the world.

You may like the tools

Cloud Storage Solutions

The technical core to synchronize your cloud storage solution with Odoo

Google Drive Odoo Integration

The tool to automatically synchronize Odoo attachments with Google Drive files in both ways

OneDrive / SharePoint Odoo Integration

The tool to automatically synchronize Odoo attachments with OneDrive files in both ways

OwnCloud / NextCloud Odoo Integration

The tool to automatically synchronize Odoo attachments with OwnCloud / NextCloud files in both ways

KnowSystem: Knowledge Base System

The tool to build deep and structured knowledge base for internal and external use. Knowledge System. KMS

Universal Appointments and Time Reservations

The tool for time-based service management from booking appointment to sale and reviews

Password Manager

The tool to safely keep passwords for shared use

KPI Balanced Scorecard

The tool to set up KPI targets and control their fulfillment by periods

198 168
Joint Calendar

The tool to combine different Odoo events in a few configurable super calendars. Shared calendar. Common calendar.

Odoo Proprietary License v1.0
This software and associated files (the "Software") may only be used (executed,
modified, executed after modifications) if you have purchased a valid license
from the authors, typically via Odoo Apps, or if you have received a written
agreement from the authors of the Software (see the COPYRIGHT file).
You may develop Odoo modules that use the Software as a library (typically
by depending on it, importing it and using its resources), but without copying
any source code or material from the Software. You may distribute those
modules under the license of your choice, provided that this license is
compatible with the terms of the Odoo Proprietary License (For example:
LGPL, MIT, or proprietary licenses similar to this one).
It is forbidden to publish, distribute, sublicense, or sell copies of the Software
or modified copies of the Software.
The above copyright notice and this permission notice must be included in all
copies or substantial portions of the Software.

Please log in to comment on this module

  • The author can leave a single reply to each comment.
  • This section is meant to ask simple questions or leave a rating. Every report of a problem experienced while using the module should be addressed to the author directly (refer to the following point).
  • If you want to start a discussion with the author or have a question related to your purchase, please use the support page.