New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs about build process #4515

Merged
merged 6 commits into from Aug 21, 2018

Conversation

Projects
None yet
3 participants
@stsewd
Member

stsewd commented Aug 13, 2018

Describe each docker image used to build the docs

ref to #4419 (comment)

Update docs about build process
Describe each docker image used to build the docs

@stsewd stsewd requested review from humitos and rtfd/core Aug 13, 2018

Show outdated Hide outdated docs/builds.rst
Show outdated Hide outdated docs/builds.rst
@humitos

Great!

I think it will be better if we sort the packages installed alphabetically.

Packages installed in the build environment
-------------------------------------------
The build server does have a select number of C libraries installed, because they are used across a wide array of python projects. We can't install every C library out there, but we try and support the major ones. We currently have the following libraries installed:

This comment has been minimized.

@humitos

humitos Aug 15, 2018

Member

I'd keep a message similar to this one inside a .. note:: so, users are aware that we can't install everything inside the docker image.

@humitos

humitos Aug 15, 2018

Member

I'd keep a message similar to this one inside a .. note:: so, users are aware that we can't install everything inside the docker image.

Show outdated Hide outdated docs/builds.rst
Show outdated Hide outdated docs/builds.rst
Show outdated Hide outdated docs/builds.rst
@ericholscher

Looks good!

@ericholscher ericholscher merged commit 6057ff9 into rtfd:master Aug 21, 2018

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

@stsewd stsewd deleted the stsewd:docs-build-process branch Aug 21, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment