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

Replace sphinxcontrib-programoutput with another package #2804

Closed
stevepiercy opened this issue Nov 1, 2016 · 4 comments
Closed

Replace sphinxcontrib-programoutput with another package #2804

stevepiercy opened this issue Nov 1, 2016 · 4 comments
Assignees
Labels
Milestone

Comments

@stevepiercy
Copy link
Member

stevepiercy commented Nov 1, 2016

sphinxcontrib-programoutput is no longer maintained and may cause future builds of the documentation to fail.

Replacement candidates include:

See #2803

@stevepiercy stevepiercy self-assigned this Nov 1, 2016
@stevepiercy stevepiercy added this to the 1.8 milestone Nov 26, 2016
@stevepiercy
Copy link
Member Author

stevepiercy commented Nov 26, 2016

pcreate and other p* scripts use optparse. Neither of the above options are possible solutions because they require argparse.

optparse is deprecated as of Python 2.7.

@mmerickel what do you think about updating p* scripts to use argparse? I found some code that might serve as a pattern to do so.

Our options include:

  1. Do nothing. Continue using sphinxcontrib-programoutput.
  2. Update p* scripts to use argparse and use one of the above supported Sphinx extensions.
  3. Remove documentation that generates the output of the p* scripts.
  4. Something else?

@mmerickel
Copy link
Member

I can't find any examples of rendered output for http://sphinxcontrib-argdoc.readthedocs.io/en/latest/.

https://pythonhosted.org/sphinxcontrib-autoprogram/ looks fine. Switching to argparse shouldn't be a big deal because they are not extensible commands - no one should be depending on their internal parsing format.

@stevepiercy
Copy link
Member Author

This issue is being worked in #2864

@stevepiercy
Copy link
Member Author

Closed by #2864

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

No branches or pull requests

2 participants