OpenLP

API documentation is empty

Bug #964644 reported by Andreas Preikschat
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenLP
Invalid
Low
Unassigned
Documentation
Fix Committed
Medium
Raoul Snyman
OpenLP 2.0 "Original Adam"

Bug Description

Hello,

I have two folders, doc-trunk (lp:openlp/documentation) and trunk (lp:openlp).

I do:
   cd doc-trunk/api && make html

When I open the index.html, the structure (headlines) is there but no text (the text from files in the trunk folder).

Either I am doing something wrong or the scripts needs to be fixed. Here the command line output: http://pastebin.com/Y445Wt9f

Regards

Related branches

lp:~raoul-snyman/openlp/bug-964644
Andreas Preikschat (community): Approve
Tim Bentley: Approve
Diff: 14 lines (+4/-0)
1 file modified
api/source/conf.py (+4/-0)
Revision history for this message
Raoul Snyman (raoul-snyman) wrote :

Mine builds fine, but my directory structure is different...

~/Projects/OpenLP/trunk
~/Projects/OpenLP-docs/trunk

Revision history for this message
Andreas Preikschat (googol-deactivatedaccount) wrote : Re: [Bug 964644] Re: API documentation is empty

> Mine builds fine, but my directory structure is different...
>
> ~/Projects/OpenLP/trunk
> ~/Projects/OpenLP-docs/trunk
>
I assume we then should add a check if the folders exist and notify the
user. Or even better add a command line switch were you can (!) specify
your own path.

Regards

Jonathan Corwin (j-corwin)
Changed in openlp:
status: New → Confirmed
matysek (mzibricky)
Changed in openlp:
milestone: none → 2.0
Revision history for this message
Raoul Snyman (raoul-snyman) wrote :

I don't know how we'd do that since that would mean changing the internals of Sphinx. All we have is a configuration file.

Raoul Snyman (raoul-snyman)
Changed in openlp:
status: Confirmed → Fix Committed
Tim Bentley (trb143)
Changed in openlp:
milestone: 2.0 → none
status: Fix Committed → Invalid
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.
Subscribing...

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.