The application implements search features into doxygen documentation.
Features:
- allows to find help pages by text into description
- supports searching by substring
- single application supports working with some instances of documentations
- don't need internet access
The application uses the Python + Django for its work.
The application is designed to run on the local computer where a generated documentation is located.
Prerequisites:
- Python vers. 3 with Django framework (free software).
Its easy to find in the Internet an information about installation process of them.
Installation
Execute the following commands in the folder of doxy-search (contains the manage.py):
- Initializing the database
python3 manage.py makemigrations
python3 manage.py migrate - Run doxy-search application
python3 manage.py runserver
In some cases you should use python instead of python3 or add the path to the application.
Usage
Open link doxy-search admin into browser and follow Quick start section (doxy-search application shall be run).
Evgeny Kislov, 2021-2022.