Skip to content
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.

Sign up for GitHub

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

ci(docs): modernize documentation building #1205

Merged
merged 2 commits into from
Feb 14, 2020
Merged

ci(docs): modernize documentation building #1205

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
37df329
ci(docs): modernize documentation building
jd Feb 13, 2020
9ca8596
Merge branch 'master' into update-doc-target
jd Feb 13, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions .circleci/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -794,14 +794,12 @@ jobs:
build_docs:
# deploy official documentation
docker:
- image: circleci/python:3.6
- image: circleci/python:3.8
resource_class: *resource_class
steps:
- checkout
- run: sudo apt-get -y install rake
# Sphinx 1.7.5 is required otherwise docs are not properly built
- run: sudo pip install mkwheelhouse sphinx==1.7.5 wrapt
- run: rake docs
- run: sudo pip install tox
- run: tox -e docs
- run:
command: |
mkdir -p /tmp/docs
Expand Down
8 changes: 0 additions & 8 deletions Rakefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,3 @@
desc "build the docs"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

whoah?! but what would a Python library be without a Ruby dependency?!

task :docs do
sh "pip install sphinx"
Dir.chdir 'docs' do
sh "make html"
end
end

# Deploy tasks
S3_DIR = ENV['S3_DIR']
S3_BUCKET = "pypi.datadoghq.com"
Expand Down
225 changes: 0 additions & 225 deletions docs/Makefile
View file
Open in desktop

This file was deleted.

7 changes: 7 additions & 0 deletions tox.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -514,6 +514,13 @@ deps=
commands=flake8 .
basepython=python3.7

[testenv:docs]
commands_pre=
skip_install=true
deps = sphinx
commands = sphinx-build -b html docs docs/_build/html
basepython = python

# do not use develop mode with celery as running multiple python versions within
# same job will cause problem for tests that use ddtrace-run
[celery_contrib]
Expand Down