Bug 47758 – (http-api) import can build Python API documentation in buildsystem

Bug 47758 - (http-api) import can build Python API documentation in buildsystem


Summary:	(http-api) import can build Python API documentation in buildsystem

Status:	RESOLVED FIXED

Product:	UCS@school
Classification:	Unclassified
Component:	Documentation
Version:	UCS@school 4.3
Hardware:	Other Linux

Importance:	P5 normal (vote)
Target Milestone:	UCS@school 4.4 v3
Assigned To:	Daniel Tröder
QA Contact:	Sönke Schwardt-Krummrich

URL:
Keywords:

Depends on:
Blocks:	45021
	Show dependency tree / graph

Reported:	2018-09-05 19:46 CEST by Daniel Tröder
Modified:	2019-04-01 00:52 CEST (History)
CC List:	0 users

See Also:
What kind of report is it?:	Development Internal
What type of bug is this?:	---
Who will be affected by this bug?:	---
How will those affected feel about the bug?:	---
User Pain:
Enterprise Customer affected?:
School Customer affected?:
ISV affected?:
Waiting Support:
Flags outvoted (downgraded) after PO Review:
Ticket number:
Bug group (optional):
Max CVSS v3 score:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.

Description Daniel Tröder

2018-09-05 19:46:08 CEST

Currently the internal documentation (package ucs-school-import-http-api-doc) will build empty Python API socumentation in the Univention buildsystem, because the ucsschool.lib and other software is not installed at build time.

Additionally Django apps need import time configuration, which is currently not available during the sphinx-doc run.

Modify the package in such a way, that the Python API documentation can build in the Univention buildsystem.

Comment 1 Daniel Tröder

2018-09-05 19:57:50 CEST

The required changes are:

* initialize Django settings and app system
* install import dependencies at build time
* create a module path containing all ucsschool Python modules

[dtroeder/47758_api_doc 6bf610417] Bug #47758: enable API doc building
[dtroeder/47758_api_doc 7e1d60af4] Bug #47758: change not required, shell.py is now ignored by sphinx

Changes were committed to git branch dtroeder/47758_api_doc.