Skip to content

Server application implements search features into a doxygen generated documentation.

License

Notifications You must be signed in to change notification settings

evgenykislov/doxy-search

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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):

  1. Initializing the database
    python3 manage.py makemigrations
    python3 manage.py migrate
  2. 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.

About

Server application implements search features into a doxygen generated documentation.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published