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 support for Sphinx directives #35

Open
Akasurde opened this issue Oct 1, 2015 · 4 comments
Open

Add support for Sphinx directives #35

Akasurde opened this issue Oct 1, 2015 · 4 comments

Comments

@Akasurde
Copy link

Akasurde commented Oct 1, 2015

I have sphinx-documentation for project which contains rst file which has links to all other document. This is achieved by "toctree" directive of sphinx.

If you run restview with such rst file which contains toctree directive, restview fails to render document.
It would be good to add support for toctree directive which will make all other rst document as hyperlinks.

I am using
Fedora 22
restview 2.4.0
Python 2.7

I would love to contribute on this feature.

@Akasurde
Copy link
Author

Akasurde commented Oct 1, 2015

restview internally uses docutils. Docutils doesn't support toctree.

Please search TOC this todo items list

Closing issue on restview for now.

@Akasurde Akasurde closed this as completed Oct 1, 2015
@mgedmin mgedmin changed the title Add support for doctree Add support for toctree Oct 1, 2015
@mgedmin
Copy link
Owner

mgedmin commented Oct 1, 2015

Yeah, it'd be nice if restview had an explicit --sphinx mode, but someone would have so submit a pull request, since I'm not likely to find time/energy to implement it myself.

I myself am using https://pypi.python.org/pypi/livereload to preview Sphinx documents.

@Akasurde
Copy link
Author

Akasurde commented Oct 1, 2015

@mgedmin if you can help me in design part for --sphinx then I can implement it.

@Akasurde Akasurde reopened this Oct 1, 2015
@mgedmin mgedmin changed the title Add support for toctree Add support for Sphinx directives Oct 1, 2015
@mgedmin
Copy link
Owner

mgedmin commented Oct 1, 2015

Sorry, I've no ideas about a possible design for this.

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