Skip to content

And Introduction and History sections #60

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

Merged
merged 2 commits into from
Nov 3, 2020
Merged

Conversation

rgommers
Copy link
Member

No description provided.

Avoid each term being a separate ToC entry in the sidebar, and
make the whole section more compact.

## History
.. note::
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

how is this doc built? does the tool support rst syntax in markdown?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was meant to, but this is the one thing that didn't work. The doc is built by installing the reqs in requirements.txt and then make html in the spec/ dir.

I bet on recommonmark back when I set this up, and should have gone all-reST or used Myst instead. My plan is to do a wholesale conversion to reST as the last step after all PRs we want to include in the first release are merged. Doing a conversion with a bunch of open PRs is a pain, so I left it till last.

Then this note will look like https://bashtage.github.io/sphinx-material/additional_samples.html?highlight=admonition#admonitions

@rgommers
Copy link
Member Author

rgommers commented Nov 3, 2020

Merging this. Thanks for having a look @szha

@rgommers rgommers merged commit bacf8d3 into master Nov 3, 2020
@rgommers rgommers deleted the intro-and-history branch November 3, 2020 18:00
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.

2 participants