izpis_h1_title_alt

Avtomatizirano generiranje dokumentacije za projekte spisane v več programskih jezikih
ID BAVČAR, MARTIN (Author), ID Demšar, Jure (Mentor) More about this mentor... This link opens in a new window

.pdfPDF - Presentation file, Download (1,12 MB)
MD5: 92AB34152C2BDA744DFC5C3CC8AC36BB

Abstract
V diplomskem delu sta predstavljena razvoj in delovanje rešitve za avtomatizirano generiranje dokumentacije programskega paketa QuNex, ki je spisan v več programskih jezikih. Sistem, ki bi na enostaven način omogočal izdelavo in objavo dokumentacije, za tak projekt v času pisanju ni bil na voljo. Pregledali smo obstoječa orodja za generiranje dokumentacije in najustreznejšega od njih nadgradili, da je izpolnjeval zahteve projekta. Generator smo iz lokalnega preselili v strežniško okolje in ga povezali z Git repozitorijem projekta. Končni izdelek je dokumentacijska spletna stran, ki se ob objavi nove različice programa v nekaj minutah posodobi in s tem uporabnikom zagotovi najnovejše informacije o uporabi dodanih in spremenjenih funkcionalnostih programa.

Language:Slovenian
Keywords:avtomatizirano generiranje dokumentacije, gostovanje dokumentacije, neprekinjena integracija in dostava, Sphinx, Read the Docs, QuNex
Work type:Bachelor thesis/paper
Typology:2.11 - Undergraduate Thesis
Organization:FRI - Faculty of Computer and Information Science
Year:2022
PID:20.500.12556/RUL-139097 This link opens in a new window
COBISS.SI-ID:119815939 This link opens in a new window
Publication date in RUL:30.08.2022
Views:743
Downloads:80
Metadata:XML DC-XML DC-RDF
:
Copy citation
Share:Bookmark and Share

Secondary language

Language:English
Title:Automated generation of documentation for projects written in multiple programming languages
Abstract:
This bachelor's thesis explores the development and deployment of the system for automated generation of documentation for The Quantitative Neuroimaging Environment & Toolbox (QuNex) software suite. The suite is developed in multiple programming languages. This was a unique challenge since the tools available at the time of writing weren't able to fully meet the documentation's requirements. We analyzed the available documentation generators and selected the most applicable one which we, in turn, enhanced with custom scripts to make it meet the requirements. We deployed the enhanced generator in a server environment which we integrated with the project's Git repository. When a new version of QuNex is released, the documentation generator automatically builds the corresponding version of the documentation and uploads it to a publicly accessible website. This allows users to find information on the new and updated features within minutes.

Keywords:automated generation of documentation, documentation hosting, continuous integration and deployment, Sphinx, Read the Docs, QuNex

Similar documents

Similar works from RUL:
Similar works from other Slovenian collections:

Back