Opened 5 years ago
Last modified 4 weeks ago
#12507 assigned enhancement
Automate BridgeDB documentation builds
Reported by: | isis | Owned by: | |
---|---|---|---|
Priority: | Low | Milestone: | |
Component: | Obfuscation/BridgeDB | Version: | |
Severity: | Normal | Keywords: | documentation, bridgedb |
Cc: | isis, sysrqb | Actual Points: | |
Parent ID: | Points: | 1 | |
Reviewer: | Sponsor: | Sponsor19 |
Description
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 https://para.noid.cat/bridgedb, mostly because I had no idea where to put it, but wanted to put it somewhere.
So...
- We should probably ask TPO's sysadmins to create something like https://docs.torproject.org/bridgedb, or wherever people want to use for keeping common developer documentation.
- 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.
- Documentation builds should probably be triggered automatically when a new signed tag is pushed to
git.torproject.org/bridgedb.git
.
Child Tickets
Change History (5)
comment:1 Changed 4 years ago by
Keywords: | isisExB added |
---|
comment:2 Changed 4 years ago by
Keywords: | isis2015Q3Q4 added |
---|
comment:3 Changed 4 years ago by
Status: | new → needs_review |
---|
comment:4 Changed 2 years ago by
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 4 weeks ago by
Keywords: | isisExB isis2015Q3Q4 removed |
---|---|
Owner: | isis deleted |
Points: | → 1 |
Sponsor: | → Sponsor19 |
Status: | needs_review → assigned |
Note: See
TracTickets for help on using
tickets.
It's not exactly automated, but in my
fix/12507-automate-documentation-builds
branch, I added some commands to themake docs
Makefile directive which ultimately produce abridgedb-$VERSION-docs.zip
file. This file can be uploaded through PyPI's maintainer interface to produce the hosted version at https://pythonhosted.com/bridgedb/.