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 sage.misc.sphinxify with docrepr #33682

Open
mkoeppe opened this issue Apr 11, 2022 · 7 comments
Open

Replace sage.misc.sphinxify with docrepr #33682

mkoeppe opened this issue Apr 11, 2022 · 7 comments

Comments

@mkoeppe
Copy link
Contributor

mkoeppe commented Apr 11, 2022

https://pypi.org/project/docrepr/

"Docrepr renders Python docstrings to HTML with Sphinx. It can generate rich and plain representations of docstrings, alongside additional metadata about the object to which the docstring belongs. It is based on the sphinxify module developed by Tim Dumol for the Sage Notebook..."

See also https://blog.jupyter.org/inspector-jupyterlab-404cce3e1df6
and https://github.com/ipython/ipython/blob/master/docs/source/whatsnew/version5.rst#provisional-changes on IPython's sphinxify_docstring, enable_html_pager options

See also spyder-ide/docrepr#20 on history

CC: @kwankyu @jhpalmieri @egourgoulhon @antonio-rojas

Component: user interface

Branch/Commit: u/mkoeppe/replace_sage_misc_sphinxify_with_docrepr @ 6275755

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

@mkoeppe mkoeppe added this to the sage-9.7 milestone Apr 11, 2022
@mkoeppe
Copy link
Contributor Author

mkoeppe commented May 29, 2022

@mkoeppe
Copy link
Contributor Author

mkoeppe commented May 29, 2022

Commit: 6275755

@mkoeppe
Copy link
Contributor Author

mkoeppe commented May 29, 2022

New commits:

6275755build/pkgs/docrepr: New

@mkoeppe

This comment has been minimized.

@mkoeppe

This comment has been minimized.

@mkoeppe mkoeppe modified the milestones: sage-9.7, sage-9.8 Aug 31, 2022
@mkoeppe mkoeppe modified the milestones: sage-9.8, sage-9.9 Jan 29, 2023
@mkoeppe mkoeppe removed this from the sage-10.0 milestone Mar 16, 2023
@tornaria
Copy link
Contributor

Doesn't seem to be widely available: https://repology.org/project/python:docrepr/versions

Also: last commit 2 years ago (https://github.com/spyder-ide/docrepr).

Sphinx seems well available and afaik it's used by python docs. Maybe sphinxify can be implemented using just docutils, but is it worth it?

OTOH, sage runs just fine without sphinx, the only difference afaict is that you get help as source rst instead of processed text, but it's not really a problem. As pointed out in #35493, the help for something like CliffordAlgebra is ugly regardless of sphinx or not sphinx.

@mkoeppe
Copy link
Contributor Author

mkoeppe commented Dec 10, 2023

Thanks for taking a look at this and giving this update.

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

2 participants