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

Create session manual from docstring #372

Merged
merged 2 commits into from Jun 15, 2015
Merged

Create session manual from docstring #372

merged 2 commits into from Jun 15, 2015

Conversation

matze
Copy link
Contributor

@matze matze commented Jun 12, 2015

This change adds a docs command to create a PDF manual from a session's docstring written in Markdown. That means

"""# *foo* session manual

## Usage

Start an experiment acquisition with

    ex.acquire('foo').join()

where `foo` denotes the data set name.

## Notes 

This *is* **ordinary** [Markdown](http://disney.com)
"""

turns into

concertdocs

@tfarago
Copy link
Contributor

tfarago commented Jun 15, 2015

Very nice 👍

matze added a commit that referenced this pull request Jun 15, 2015
Create session manual from docstring
@matze matze merged commit 8981ff5 into master Jun 15, 2015
@matze matze removed the in progress label Jun 15, 2015
@matze matze deleted the session-docs branch June 15, 2015 08:09
@tfarago
Copy link
Contributor

tfarago commented Jun 15, 2015

@MarcusZuber this might be interesting for you too.

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

Successfully merging this pull request may close these issues.

None yet

2 participants