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

chore(dist): add docs *.md files to sdist #1813

Merged
merged 1 commit into from
Jan 8, 2022

Conversation

derekschrock
Copy link
Contributor

build_sphinx to fail due to setup.cfg warning-is-error

build_sphinx to fail due to setup.cfg warning-is-error
@nejch
Copy link
Member

nejch commented Jan 8, 2022

Thanks for this @derekschrock! Does this come from https://github.com/freebsd/freebsd-ports/tree/main/devel/py-python-gitlab?

If so maybe I can add some tests to build docs from sdist to avoid this in the future. https://github.com/python-gitlab/python-gitlab/blob/main/tests/smoke/test_dists.py

@nejch nejch merged commit 4861883 into python-gitlab:main Jan 8, 2022
@derekschrock
Copy link
Contributor Author

derekschrock commented Jan 8, 2022

Thanks for this @derekschrock! Does this come from https://github.com/freebsd/freebsd-ports/tree/main/devel/py-python-gitlab?

Yes, however it doesn't block updating the port I can just add the file to the port until it's included in the sdist.

freebsd-git pushed a commit to freebsd/freebsd-ports that referenced this pull request Jan 13, 2022
- Update to 3.0.0 [1]
- Add missing dist file docs/changelog.md [2]
- Add patch to fix sphinx 4.1 feature autodoc_typehints both [3][4]

[1] https://github.com/python-gitlab/python-gitlab/releases/tag/v3.0.0
[2] python-gitlab/python-gitlab#1813
[3] https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html
[4] https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=257116

PR:		261026
Reported by:	Derek Schrock (maintainer)
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.

None yet

2 participants