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

Follow up to #21785, use nodoctest instead of .nodoctest #29450

Closed
kiwifb opened this issue Apr 2, 2020 · 9 comments
Closed

Follow up to #21785, use nodoctest instead of .nodoctest #29450

kiwifb opened this issue Apr 2, 2020 · 9 comments

Comments

@kiwifb
Copy link
Member

kiwifb commented Apr 2, 2020

In #21785 we changed the name of the file used to indicate that a folder shouldn't be doctested from nodoctest.py to .nodoctest. This stopped the python installation procedure from wanting to byte compile a file that is either empty or only text. Unfortunately, dot file are not included in the glob formula for installation. So, .nodoctest is not installed with the other files which is inconvenient for distribution and anyone who want to run doctest against the install rather than the sources.

CC: @mkoeppe

Component: doctest framework

Author: François Bissey

Branch/Commit: 3ed398c

Reviewer: Matthias Koeppe

Issue created by migration from https://trac.sagemath.org/ticket/29450

@kiwifb kiwifb added this to the sage-9.1 milestone Apr 2, 2020
@kiwifb
Copy link
Member Author

kiwifb commented Apr 2, 2020

Commit: 3ed398c

@kiwifb
Copy link
Member Author

kiwifb commented Apr 2, 2020

Branch: u/fbissey/nodoctest

@kiwifb
Copy link
Member Author

kiwifb commented Apr 2, 2020

comment:1

I finally remembered that I needed to do this. The last month has been somewhat of a tough ride. I decided against testing against .nodoctest as well as nodoctest and nodoctest.py in control.py. Since, hopefully we'll do everything on the same release and .nodoctest is not installed, there shouldn't be any issues.


New commits:

3ed398creplace .nodoctest with nodoctest

@kiwifb
Copy link
Member Author

kiwifb commented Apr 2, 2020

Author: François Bissey

@mkoeppe
Copy link
Member

mkoeppe commented Apr 2, 2020

comment:2

Which glob formula are you referring to?

@kiwifb
Copy link
Member Author

kiwifb commented Apr 2, 2020

comment:3

The one for package_data in setup.py. The alternative is to try to glob dotfiles as well. I don't think that's worth it.

@kiwifb
Copy link
Member Author

kiwifb commented Apr 2, 2020

comment:4

That bit

      package_data = {
          'sage.libs.gap': ['sage.gaprc'],
          'sage.doctest':  ['tests/*'],
          'sage': ['ext_data/*',
                   'ext_data/kenzo/*',
                   'ext_data/singular/*',
                   'ext_data/singular/function_field/*',
                   'ext_data/images/*',
                   'ext_data/doctest/*',
                   'ext_data/doctest/invalid/*',
                   'ext_data/doctest/rich_output/*',
                   'ext_data/doctest/rich_output/example_wavefront/*',
                   'ext_data/gap/*',
                   'ext_data/gap/joyner/*',
                   'ext_data/mwrank/*',
                   'ext_data/notebook-ipython/*',
                   'ext_data/nbconvert/*',
                   'ext_data/graphs/*',
                   'ext_data/pari/*',
                   'ext_data/pari/dokchitser/*',
                   'ext_data/pari/buzzard/*',
                   'ext_data/pari/simon/*',
                   'ext_data/magma/*',
                   'ext_data/magma/latex/*',
                   'ext_data/magma/sage/*',
                   'ext_data/valgrind/*',
                   'ext_data/threejs/*']
      },

@mkoeppe
Copy link
Member

mkoeppe commented Apr 2, 2020

Reviewer: Matthias Koeppe

@vbraun
Copy link
Member

vbraun commented Apr 9, 2020

Changed branch from u/fbissey/nodoctest to 3ed398c

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

No branches or pull requests

3 participants