How can I display generated documentation (sphinx) in my repo?

jlaforet October 3, 2015

My python projects have automatically generated documentation (by sphinx).

How can I display the documentation in the repository for all developers?

For public repo, i'd use readthedocs, but i can't find a way to do something in a private repo.

2 answers

1 accepted

Comments for this post are closed

Community moderators have prevented the ability to post new answers.

Post a new question

0 votes
Answer accepted
evzijst
Atlassian Team
Atlassian Team members are employees working across the company in a wide variety of roles.
October 5, 2015

Bitbucket does not natively understand or compile Sphinx documentation and so when readthedocs is not available for hosting, you'll have to provide an alternative of your own.

Now you can host a static HTML site on Bitbucket (https://confluence.atlassian.com/bitbucket/publishing-a-website-on-bitbucket-221449776.html), but that will not help you compile the documentation. Also, "hosted repos" are publicly accessible, which would be at odds with your private content.

0 votes
Kaz October 4, 2015

I hope you can have a public wiki for your private repo. On Bitbucket, a wiki is just another repository and you can push your documents there. Otherwise, you may create another public repo just for your documents if you want to use webhooks. 

Kaz October 4, 2015

Excuse me, it is now Bitbucket Cloud. :)

TAGS
AUG Leaders

Atlassian Community Events