tahoe-lafs/tahoe-lafs
tahoe-lafs
/
tahoe-lafs
2
0
Fork 0
Code Issues Pull Requests 23 Packages Projects Releases 1 Wiki Activity

3663 Add a "make livehtml" rule for building documentation #1028

Merged
sajith merged 2 commits from 3663.sphinx-autobuild-make-rule into master 2021-04-03 11:43:31 +00:00
Conversation 1 Commits 2 Files Changed 2 +5
sajith commented 2021-04-02 21:36:56 +00:00 (Migrated from github.com)
Copy Link

Ticket is https://tahoe-lafs.org/trac/tahoe-lafs/ticket/3663.

I found that sphinx-autobuild is very nifty to have when editing documentation: it lets us preview changes to documentation locally, right in a web browser. This PR will add a make livehtml rule which will invoke sphinx-autobuild.

Ticket is https://tahoe-lafs.org/trac/tahoe-lafs/ticket/3663. I found that [sphinx-autobuild](https://github.com/executablebooks/sphinx-autobuild) is very nifty to have when editing documentation: it lets us preview changes to documentation locally, right in a web browser. This PR will add a `make livehtml` rule which will invoke sphinx-autobuild.
coveralls commented 2021-04-02 22:34:55 +00:00 (Migrated from github.com)
Copy Link

Coverage Status

Coverage decreased (-0.02%) to 94.549% when pulling c13fb8d7ef on 3663.sphinx-autobuild-make-rule into b6528249fb on master.

[![Coverage Status](https://coveralls.io/builds/38503962/badge)](https://coveralls.io/builds/38503962) Coverage decreased (-0.02%) to 94.549% when pulling **c13fb8d7effb40aba19d5068495323f15139152c on 3663.sphinx-autobuild-make-rule** into **b6528249fb1978f84a640a24d603463c308777ef on master**.
meejah (Migrated from github.com) approved these changes 2021-04-03 02:38:02 +00:00
meejah (Migrated from github.com) left a comment
Copy Link

LGTM

LGTM
Sign in to join this conversation.
Reviewers
No reviewers
meejah
Labels
Clear labels   
Benchmarking and Performance

   
HTTP Storage Protocol

   
Nevow Removal

   
Python 3 Porting

   
not-for-merge
No Label
Benchmarking and Performance
HTTP Storage Protocol
Nevow Removal
Python 3 Porting
not-for-merge
Milestone
Clear milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
No Assignees
1 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: tahoe-lafs/tahoe-lafs#1028
No description provided.
Delete Branch "3663.sphinx-autobuild-make-rule"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?