[sphinx-users] Re: Using README.md as index
Hi Tzach.
I didn't include relative path in my project. I just used m2r with "..
mdinclude" in my RST file.
Sorry for my wrong answer.
2017년 11월 28일 화요일 오후 6시 54분 41초 UTC+9, Tzach Livyatan 님의 말:
>
> Thanks for teh advice
> I try to use m2r with no luck
> In the root README.md file I have [manual](manual/) link, which should
> point to ./manual/README.md file. Instead, the link is to ./README/manual/
> which is wrong (no need for the first README in the path)
> Any input will be appreciated
>
>
> On Sunday, November 26, 2017 at 1:00:05 PM UTC+2, Juncheol Cho wrote:
>>
>> How about to use m2r ? https://github.com/miyakogi/m2r
>> I am using it in small documentation, and it is working well, also easy
>> to use.
>>
>>
>> 2017년 11월 20일 월요일 오후 10시 44분 47초 UTC+9, Tzach Livyatan 님의 말:
>>>
>>> As part of a bigger Sphinx ReST project, I have a submodule of Markdown
>>> files.
>>> Add Markdown prove to be easy as
>>> from recommonmark.parser import CommonMarkParser
>>> source_parsers = {'.md': CommonMarkParser}
>>> source_suffix = ['.rst', '.md']
>>>
>>>
>>> But the solution is not complete.
>>> In particular, link in the format of [manual](manual/) breaks, as the
>>> root files under the manual dir is README.md, not index as link expect.
>>> Any advice?
>>> Is there a configuration to use README.md as index.rst?
>>>
>>> Thanks
>>> Tzach
>>>
>>
--
You received this message because you are subscribed to the Google Groups
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.
[sphinx-users] Re: Using README.md as index
Thanks for teh advice
I try to use m2r with no luck
In the root README.md file I have [manual](manual/) link, which should
point to ./manual/README.md file. Instead, the link is to ./README/manual/
which is wrong (no need for the first README in the path)
Any input will be appreciated
On Sunday, November 26, 2017 at 1:00:05 PM UTC+2, Juncheol Cho wrote:
>
> How about to use m2r ? https://github.com/miyakogi/m2r
> I am using it in small documentation, and it is working well, also easy to
> use.
>
>
> 2017년 11월 20일 월요일 오후 10시 44분 47초 UTC+9, Tzach Livyatan 님의 말:
>>
>> As part of a bigger Sphinx ReST project, I have a submodule of Markdown
>> files.
>> Add Markdown prove to be easy as
>> from recommonmark.parser import CommonMarkParser
>> source_parsers = {'.md': CommonMarkParser}
>> source_suffix = ['.rst', '.md']
>>
>>
>> But the solution is not complete.
>> In particular, link in the format of [manual](manual/) breaks, as the
>> root files under the manual dir is README.md, not index as link expect.
>> Any advice?
>> Is there a configuration to use README.md as index.rst?
>>
>> Thanks
>> Tzach
>>
>
--
You received this message because you are subscribed to the Google Groups
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.
[sphinx-users] Re: Using README.md as index
How about to use m2r ? https://github.com/miyakogi/m2r
I am using it in small documentation, and it is working well, also easy to
use.
2017년 11월 20일 월요일 오후 10시 44분 47초 UTC+9, Tzach Livyatan 님의 말:
>
> As part of a bigger Sphinx ReST project, I have a submodule of Markdown
> files.
> Add Markdown prove to be easy as
> from recommonmark.parser import CommonMarkParser
> source_parsers = {'.md': CommonMarkParser}
> source_suffix = ['.rst', '.md']
>
>
> But the solution is not complete.
> In particular, link in the format of [manual](manual/) breaks, as the root
> files under the manual dir is README.md, not index as link expect.
> Any advice?
> Is there a configuration to use README.md as index.rst?
>
> Thanks
> Tzach
>
--
You received this message because you are subscribed to the Google Groups
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to sphinx-users+unsubscr...@googlegroups.com.
To post to this group, send email to sphinx-users@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.
