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

Add pandoc to travis-ci. #2239

Closed
wants to merge 2 commits into from

Conversation

daspecster
Copy link
Contributor

I want to make sure this installs on travis without issue.

@daspecster daspecster added docs do not merge Indicates a pull request not ready for merge, due to either quality or timing. labels Sep 2, 2016
@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Sep 2, 2016
@dhermes
Copy link
Contributor

dhermes commented Sep 2, 2016

@daspecster I also didn't get a notification about this PR. I wonder what's up with GitHub?

@dhermes
Copy link
Contributor

dhermes commented Sep 2, 2016

Also, we intentionally use sudo: false to get the new infra. on Travis.

This PR doesn't explain why pandoc is needed.

@daspecster
Copy link
Contributor Author

Hmm, I didn't assign anyone to it. I just wanted to play with some stuff. That might be why you didn't get notified?

So I'm thinking of using pandoc to parse some of the RST *-api.rst and *-usage.rst files to then be inserted into the JSON tree somewhere.

@theacodes
Copy link
Contributor

why not just use the restructuredtext library?

@dhermes
Copy link
Contributor

dhermes commented Sep 2, 2016

Big time 👎 on using pandoc. Agree with @jonparrott

@daspecster
Copy link
Contributor Author

daspecster commented Sep 2, 2016

@jonparrott, docutils? I parsed it with that using the rst2html.py script, but when there's an error (like an unknown directive found), it injects the error into the html.

Pandoc seems to clean those up and handle the some of the navigation issues fairly well.

docutils Example:
screen shot 2016-09-02 at 2 15 51 pm

I'm all ears(eyes in this case) on suggestions. I would really like to try and not write more bug prone parsing code to handle these things.

@dhermes
Copy link
Contributor

dhermes commented Sep 2, 2016

The pan in pandoc is the problem. We don't need a jackhammer, just like a tiny magnifying glass or something.

@theacodes
Copy link
Contributor

@daspecster the rst parser in docutils is really quite flexible, but perhaps you'd be better off starting with a sphinx extension to do what you need?

@daspecster
Copy link
Contributor Author

daspecster commented Sep 2, 2016

@dhermes that is true. I'm sure there's more stuff out there.

@jonparrott, I spent about a week with sphinx, sphinx extensions, docutils and the way that the node tree is built, I couldn't find a way to extract the correct parts of the docstrings.

It would add the nav and references since those are sphinx directives anyway. Those links don't work in the JSON site.

It seems redundant to parse them with sphinx and then parse them again to clean it up.
You can kind of see what's happening under the hood by using the json or xml builders.

@daspecster daspecster closed this Sep 2, 2016
@daspecster daspecster deleted the add-pandoc-to-travis branch January 24, 2017 15:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes This human has signed the Contributor License Agreement. do not merge Indicates a pull request not ready for merge, due to either quality or timing.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants