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.

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

Remove docutils dependency #2154

Merged
merged 1 commit into from
Sep 16, 2020
Merged

Remove docutils dependency #2154

merged 1 commit into from
Sep 16, 2020

Conversation

nateprewitt
Copy link
Contributor

@nateprewitt nateprewitt commented Sep 16, 2020

Now that we've removed upstream dependencies on botocore to supply docutils, we're able to remove the dependency completely. This should not affect existing users of botocore since the dependency was primarily for help documentation in AWS CLI and local doc generation.

Doc generation should run now without this dependency and if extended usage of the doc suite is needed for some reason, requirements-docs.txt still supplies the original dependency tree. Please note bcdoc is not a public interface and is subject to further change without warning.

This should resolve #900, #933, #1942, #1944, #2120, #2121.

@codecov-commenter
Copy link

codecov-commenter commented Sep 16, 2020

Codecov Report

Merging #2154 into develop will increase coverage by 5.17%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff             @@
##           develop    #2154      +/-   ##
===========================================
+ Coverage    93.11%   98.29%   +5.17%     
===========================================
  Files           60       58       -2     
  Lines        11143    10556     -587     
===========================================
  Hits         10376    10376              
+ Misses         767      180     -587     

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9afb4a9...dd24dd1. Read the comment docs.

Copy link
Member

@kyleknap kyleknap left a comment

Choose a reason for hiding this comment

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

Cool. Looks good to me. Just a small comment

@@ -2,6 +2,5 @@ tox>=2.5.0,<3.0.0
nose==1.3.7
mock==1.3.0
wheel==0.24.0
docutils>=0.10,<0.16
Copy link
Member

Choose a reason for hiding this comment

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

I think we should remove it from the requirements-docs.txt as well. There is not really a point to keep this around since the file is really only used to help with HTML doc generation and docutils was never actually ever used to generate botocore/boto3 docs.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We actually need this here because older versions of Sphinx have a relatively unbounded dependency on docutils. We'll need to install it until we upgrade Sphinx, so this identifier let's us keep control for now. I'll make a TODO to work on the Sphinx changes in a future PR.

Copy link
Member

@kyleknap kyleknap left a comment

Choose a reason for hiding this comment

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

Looks good! 🚢

@nateprewitt nateprewitt merged commit 4aff378 into boto:develop Sep 16, 2020
@nateprewitt nateprewitt deleted the docutils branch September 16, 2020 23:49
archlinux-github pushed a commit to archlinux/svntogit-community that referenced this pull request Oct 23, 2022
…elf as the maintainer; switch to sha256sums

Among new deps, python-certifi addresses https://archlinux.org/todo/use-system-ca-store/

Also, drops python-docutils as upstream dropped it some time ago boto/botocore#2154

git-svn-id: file:///srv/repos/svn-community/svn@1334330 9fca08f4-af9d-4005-b8df-a31f2cc04f65
archlinux-github pushed a commit to archlinux/svntogit-community that referenced this pull request Oct 23, 2022
…elf as the maintainer; switch to sha256sums

Among new deps, python-certifi addresses https://archlinux.org/todo/use-system-ca-store/

Also, drops python-docutils as upstream dropped it some time ago boto/botocore#2154


git-svn-id: file:///srv/repos/svn-community/svn@1334330 9fca08f4-af9d-4005-b8df-a31f2cc04f65
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Consider removing docutils from dependencies
3 participants