Skip to content

0.8.0: sphinx 4.0.2 warnings #48

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

Closed
kloczek opened this issue Jun 18, 2021 · 3 comments · Fixed by #63
Closed

0.8.0: sphinx 4.0.2 warnings #48

kloczek opened this issue Jun 18, 2021 · 3 comments · Fixed by #63
Assignees

Comments

@kloczek
Copy link

kloczek commented Jun 18, 2021

+ /usr/bin/python3 setup.py build_sphinx -b man --build-dir build/sphinx
/usr/lib/python3.8/site-packages/setuptools/dist.py:454: UserWarning: Normalizing 'v0.8.0' to '0.8.0'
  warnings.warn(tmpl.format(**locals()))
running build_sphinx
Running Sphinx v4.0.2
making output directory... done
WARNING: html_static_path entry '_static' does not exist
building [mo]: targets for 0 po files that are out of date
building [man]: all manpages
updating environment: [new config] 4 added, 0 changed, 0 removed
reading sources... [100%] usage
WARNING: autodoc: failed to import module 'fetch' from module 'stdlib_list'; the following exception was raised:
cannot import name 'base_dir' from 'stdlib_list' (/home/tkloczko/rpmbuild/BUILD/python-stdlib-list-0.8.0/stdlib_list/__init__.py)
/home/tkloczko/rpmbuild/BUILD/python-stdlib-list-0.8.0/stdlib_list/__init__.py:docstring of stdlib_list.base.in_stdlib:14: WARNING: Field list ends without a blank line; unexpected unindent.
/home/tkloczko/rpmbuild/BUILD/python-stdlib-list-0.8.0/stdlib_list/__init__.py:docstring of stdlib_list.base.in_stdlib:18: WARNING: Field list ends without a blank line; unexpected unindent.
/home/tkloczko/rpmbuild/BUILD/python-stdlib-list-0.8.0/stdlib_list/__init__.py:docstring of stdlib_list.base.stdlib_list:6: WARNING: Field list ends without a blank line; unexpected unindent.
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... python-stdlib-list.3 { install usage fetch } done
build succeeded, 5 warnings.
sanjayankur31 added a commit to sanjayankur31/python-stdlib-list that referenced this issue Aug 31, 2021
These are used in fetch.py.

Were removed in 267fd1c but the
fetch.py code has not yet been updated to work without these.

Should also fix pypi#48
sanjayankur31 added a commit to sanjayankur31/python-stdlib-list that referenced this issue Aug 31, 2021
These are used in fetch.py.

Were removed in 267fd1c but the
fetch.py code has not yet been updated to work without these.

Should also fix pypi#48
@woodruffw woodruffw self-assigned this Jun 10, 2023
@woodruffw
Copy link
Member

#63 includes changes that address this.

@kloczek
Copy link
Author

kloczek commented Jun 11, 2023

Cannot apply that commit on top of last release

[tkloczko@pers-jacek SPECS]$ rpmbuild -bp python-stdlib-list.spec
warning: Downloading https://github.com/pypi/stdlib-list//archive/v0.8.0/python-stdlib-list-0.8.0.tar.gz to /home/tkloczko/rpmbuild/SOURCES/python-stdlib-list-0.8.0.tar.gz
warning: Downloading https://github.com/pypi/stdlib-list//pull/63.patch#/python-stdlib-list-treewide-PEP-517-8.patch to /home/tkloczko/rpmbuild/SOURCES/python-stdlib-list-treewide-PEP-517-8.patch
Executing(%prep): /bin/sh -e /var/tmp/rpm-tmp.mJxU8x
+ umask 022
+ cd /home/tkloczko/rpmbuild/BUILD
+ rm -rf stdlib-list-0.8.0
+ /usr/bin/gzip -dc /home/tkloczko/rpmbuild/SOURCES/python-stdlib-list-0.8.0.tar.gz
+ /usr/bin/tar -xof -
+ STATUS=0
+ '[' 0 -ne 0 ']'
+ cd stdlib-list-0.8.0
+ /usr/bin/chmod -Rf a+rX,u+w,g-w,o-w .
+ /usr/bin/cat /home/tkloczko/rpmbuild/SOURCES/python-stdlib-list-treewide-PEP-517-8.patch
+ /usr/bin/patch -p1 -s --fuzz=0 --no-backup-if-mismatch -f
1 out of 1 hunk FAILED -- saving rejects to file stdlib_list/_version.py.rej
error: Bad exit status from /var/tmp/rpm-tmp.mJxU8x (%prep)

@kloczek
Copy link
Author

kloczek commented Jun 22, 2023

Just tested 0.9.0 and all looks better now 😄

+ /usr/bin/sphinx-build -n -T -b man docs build/sphinx/man
Running Sphinx v6.2.1
making output directory... done
WARNING: html_static_path entry '_static' does not exist
building [mo]: targets for 0 po files that are out of date
writing output...
building [man]: all manpages
updating environment: [new config] 3 added, 0 changed, 0 removed
reading sources... [100%] usage
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... python-stdlib-list.3 { install usage } done
build succeeded, 1 warning.

Still it is one small warning but .. 😋

Is it possible to add below patch for next release? 🤔

--- a/docs/conf.py
+++ b/docs/conf.py
@@ -12,12 +12,14 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.

-from stdlib_list import __version__
-
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-# sys.path.insert(0, os.path.abspath('.'))
+import sys
+import os
+sys.path.insert(0, os.path.abspath(".."))
+
+from stdlib_list import __version__

 # -- General configuration ------------------------------------------------

It allows build documentation without have module installed and it does exactly what is described in comment above added lines.

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 a pull request may close this issue.

2 participants