[WIP] Convert to RST for Read The Docs (RTD) #115
Conversation
Including config
| @@ -6,7 +7,7 @@ suitable to the situation. The basic form of object creation could result in | |||
| design problems or added complexity to the design. Creational design patterns | |||
| solve this problem by somehow controlling this object creation. | |||
|
|
|||
| * [AbstractFactory](AbstractFactory) [:notebook:](http://en.wikipedia.org/wiki/Abstract_factory_pattern) | |||
| * :doc:`AbstractFactory <AbstractFactory/README>` `Wikipedia <http://en.wikipedia.org/wiki/Abstract_factory_pattern>`_ | |||
There was a problem hiding this comment.
Doesn't look like correct way of adding external link. See http://sphinx-doc.org/rest.html#external-links : inline link
`Link text <http://example.com/>`_ `
There was a problem hiding this comment.
There are 2 links there:
1. :doc:`AbstractFactory <AbstractFactory/README>`
2. `Wikipedia <http://en.wikipedia.org/wiki/Abstract_factory_pattern>`_
From the docs:
External links
UseLink text http://example.com/_ for inline web links
There was a problem hiding this comment.
-
Is an Internal link
From the documentation http://sphinx-doc.org/markup/inline.html#cross-referencing-documents
Cross-referencing documents
There is also a way to directly link to documents:
:doc:
Link to the specified document; the document name can be specified in absolute or relative fashion. For example, if the reference :doc:parrotoccurs in the document sketches/index, then the link refers to sketches/parrot. If the reference is :doc:/peopleor :doc:../people, the link refers to people.Therefore, an extension is not require - I read somewhere it would work for PDFs too.
-
Is an External link
There was a problem hiding this comment.
This works well locally, but on Read The Docs, it does not work. I will investigate more.
There was a problem hiding this comment.
@eddiejaoude did you investigate and found the reason? I would really like to merge this in 👍
There was a problem hiding this comment.
@domnikl I didn't think there was much interest, so I put it lower down my list. I can look into it again.
|
Closing this PR as it has been superseded by #131 |
Using modified PR template from TransformCore PR Checklist