Opened 6 years ago

Last modified 6 months ago

#12507 new enhancement

Automate BridgeDB documentation builds

Reported by: isis Owned by:
Priority: Low Milestone:
Component: Circumvention/BridgeDB Version:
Severity: Normal Keywords: documentation, bridgedb, ex-sponsor19, GSoD
Cc: isis, sysrqb Actual Points:
Parent ID: Points: 1
Reviewer: Sponsor:


The developer documentation for BridgeDB needs a place to live. Currently, Sphinx builds can be manually triggered to produce HTML documentation (as well as other types). I have been manually scp'ing it to, mostly because I had no idea where to put it, but wanted to put it somewhere.


  1. We should probably ask TPO's sysadmins to create something like, or wherever people want to use for keeping common developer documentation.
  1. I think there was some sort of funding for this. I've just been doing this because I needed to understand how BridgeDB works and it was entirely undocumented when I started working on it. If someone knows who that funder is, please comment/tag this ticket as appropriate.
  1. Documentation builds should probably be triggered automatically when a new signed tag is pushed to

Child Tickets

Change History (8)

comment:1 Changed 6 years ago by isis

Keywords: isisExB added

comment:2 Changed 6 years ago by isis

Keywords: isis2015Q3Q4 added

comment:3 Changed 5 years ago by isis

Status: newneeds_review

It's not exactly automated, but in my fix/12507-automate-documentation-builds branch, I added some commands to the make docs Makefile directive which ultimately produce a bridgedb-$ file. This file can be uploaded through PyPI's maintainer interface to produce the hosted version at

comment:4 Changed 4 years ago by cass

Keywords: SponsorZ removed
Severity: Normal

Removing SponsorZ tag because it looks like the issue has mostly been resolved. Please re-add tag if this is not the case and/or it becomes an active issue that needs new funding.

comment:5 Changed 19 months ago by gaba

Keywords: isisExB isis2015Q3Q4 removed
Owner: isis deleted
Points: 1
Sponsor: Sponsor19
Status: needs_reviewassigned

comment:6 Changed 14 months ago by gaba

Keywords: ex-sponsor19 added
Sponsor: Sponsor19

Remove sponsor 19 and add a keyword ex-sponsor19 to mark all the tickets that could have been in the scope of the sponsor.

comment:7 Changed 14 months ago by pili

Keywords: GSoD added

comment:8 Changed 6 months ago by teor

Status: assignednew

Change tickets that are assigned to nobody to "new".

Note: See TracTickets for help on using tickets.