Opened 4 years ago

Last modified 2 years ago

#12507 needs_review enhancement

Automate BridgeDB documentation builds

Reported by: isis Owned by: isis
Priority: Low Milestone:
Component: Obfuscation/BridgeDB Version:
Severity: Normal Keywords: documentation, bridgedb, isisExB, isis2015Q3Q4
Cc: isis, sysrqb Actual Points:
Parent ID: Points:
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 (4)

comment:1 Changed 4 years ago by isis

Keywords: isisExB added

comment:2 Changed 4 years ago by isis

Keywords: isis2015Q3Q4 added

comment:3 Changed 4 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 2 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.

Note: See TracTickets for help on using tickets.