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.

Sign up for GitHub

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

Jump to bottom

Add Sphinx directive to read function documentation from a shell script #24023

Open
embray opened this issue Oct 12, 2017 · 4 comments
Open

Add Sphinx directive to read function documentation from a shell script #24023

embray opened this issue Oct 12, 2017 · 4 comments
Assignees
@embray
Labels
c: documentation p: major / 3 pending

Comments

@embray
Copy link
Contributor

embray commented Oct 12, 2017

In #23160 I added an initial library of helper functions for use in spkg-build/install. Those functions are defined and documented in build/bin/sage-dist-helpers, and now also documented in the developer's guide (#28721).

I'm experimenting now with a Sphinx directive to read function documentation from the shell script. Will update once I have something working.

Component: documentation

Issue created by migration from https://trac.sagemath.org/ticket/24023
@embray embray added this to the sage-8.1 milestone Oct 12, 2017
@embray embray self-assigned this Oct 12, 2017
@embray embray modified the milestones: sage-8.1, sage-8.2 Dec 12, 2017
@embray embray modified the milestones: sage-8.2, sage-8.3 Apr 26, 2018
@embray embray modified the milestones: sage-8.3, sage-8.4 Jul 18, 2018
@embray embray modified the milestones: sage-8.4, sage-8.5 Oct 28, 2018
@embray
Copy link
Contributor Author

embray commented Dec 28, 2018

comment:6

Retargeting some of my tickets.

@embray embray modified the milestones: sage-8.5, sage-8.7 Dec 28, 2018
@embray
Copy link
Contributor Author

embray commented Mar 25, 2019

comment:7

Removing most of the rest of my open tickets out of the 8.7 milestone, which should be closed.

@embray embray removed this from the sage-8.7 milestone Mar 25, 2019
@embray embray added the pending label Mar 25, 2019
@embray
Copy link
Contributor Author

embray commented Nov 12, 2019

comment:8

There is a solution for this proposed in #28721.

@jhpalmieri

This comment has been minimized.

Sign in to view
@jhpalmieri jhpalmieri changed the title Document sage-dist-helpers helper functions Add Sphinx directive to read function documentation from a shell script Nov 12, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@embray embray

Labels
c: documentation p: major / 3 pending
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@embray @jhpalmieri