It's not the same without you

Join the community to find out what other Atlassian users are discussing, debating and creating.

Atlassian Community Hero Image Collage

Building Sphinx documentation and deploying build artifacts using Bitbucket Pipelines?

Brian King Jul 07, 2016

Hi,

I just received an invite for the Bitbucket Pipelines beta, psyched to try it out. I'm attempting to build Sphinx docs (and possibly MkDocs) documentation and then deploy the build artifacts generated from make html and make latexpdf (in the case of Sphinx).

I know services such as ReadTheDocs are available, however, in this use case I need the documentation generated by Sphinx or MkDocs to remain private.

Can anyone offer any guidance as to accomplish any of the following:

  • Commit build artifacts as a release in source repo (3rd best, tied with downloading build artifacts)
  • Provide a method of downloading the build artifacts as a zip/tar.gz (3rd best, tied with downloading build artifacts)
  • Deploy the HTML (and PDF, when using Sphinx) to Bitbucket Aerobatic (2nd best option)
  • Deploy the HTML (and PDF, when using Sphinx) to CentOS server via SSH/FTP (best option)

Here's the Bitbucket Pipelines file I quickly mashed up, however, I just found a few Docker images for Sphinx that will likely be a much better option to cut down on pipelines processing time (as this build took over 1 hour since Latexpdf is so large).

bitbucket-pipelines.yml

# You can use a Docker image from Docker Hub or your own container
# registry for your build environment.
image: python:2.7
pipelines:
  default:
    - step:
        script: # Modify the commands below to build your repository.
          - apt-get -qq update
          - apt-get install -y texlive-full
          - pip install -r requirements.txt
          - make html
          - make latexpdf

Thanks!

2 answers

0 votes
Brian King Jul 07, 2016

The build succeeds and I know the artifacts are inside the container at: 

Build finished. The HTML pages are in build/html.

 

pdflatex finished; the PDF files are in build/latex.

 

0 votes
Steven Vaccarella Atlassian Team Jul 12, 2016

I just wrote up this guide on setting up ssh public-key authentication for use inside Pipelines. It seems like it might help with your preferred option.

https://answers.atlassian.com/questions/39429257

Suggest an answer

Log in or Sign up to answer
This widget could not be displayed.
This widget could not be displayed.
Community showcase
Published in Bitbucket Pipelines

Building a Bitbucket Pipe as a casual coder

...ipe.sh :  #!/bin/bash source "$(dirname "$0")/common.sh" enable_debug extra_args="" if [[ "${DEBUG}" == "true" ]]; then extra_args="--verbose" fi # mandatory variables R...

1,696 views 1 18
Read article

Community Events

Connect with like-minded Atlassian users at free events near you!

Find an event

Connect with like-minded Atlassian users at free events near you!

Unfortunately there are no Community Events near you at the moment.

Host an event

You're one step closer to meeting fellow Atlassian users at your local event. Learn more about Community Events

Events near you