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

setup.py keywords |version| & |today| #36

Open
jayvdb opened this issue Jun 13, 2018 · 2 comments
Open

setup.py keywords |version| & |today| #36

jayvdb opened this issue Jun 13, 2018 · 2 comments

Comments

@jayvdb
Copy link
Member

jayvdb commented Jun 13, 2018

The setup.py template has function filter_out_test_code which filters out

  • .. testcode:
  • |version|
  • |today|

Those last two are Sphinx substitutions, and are not 'test code', so the function should be given a more generic name, and/or a little code comment would be helpful as not everyone knows what those are. Also |release| should be added too I guess, just for completeness?

My guess is this function is actually a Sphinx->docutils RST conversion, removing stuff that wont render on PyPi.

@chfw
Copy link
Member

chfw commented Jun 13, 2018

these filters try to cleanse README.rst. pypi website cannot render those sphinx macros. Not sure if the update site would have the same problem or not.

@jayvdb
Copy link
Member Author

jayvdb commented Jun 14, 2018

Ok, so we need to check whether the new pypi site can handle/discard sphinx syntax.
If not, this function should be renamed to be sphinx_to_rst.

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

No branches or pull requests

2 participants