docs: builds readthedocs #832
Conversation
docs/tutorials.rst
Outdated
| @@ -42,7 +42,7 @@ CAP-client | |||
| ------------- | |||
|
|
|||
| The CAP-client is a command-line tool for preserving analyses. | |||
| It is implemented as a python package and its documentation can be found `here <https://cap-client.readthedocs.io>`_. | |||
| It is implemented as a python package and its documentation can be found `here <https://cap-client.readthedocs.io>`__. | |||
There was a problem hiding this comment.
Should be only one trailing _ in reST links....
There was a problem hiding this comment.
hmmmm, not sure about that, if I have it only one is failing with this error
sphinx-doc/sphinx#3921
There was a problem hiding this comment.
@tiborsimko ok you are right, was failing when I tried to build it locally but seems that it is not an issue. I updated the PR.
There was a problem hiding this comment.
Ah, if the link target is the same, you can define it once and use it multiple times like:
This is `foo`_ and...
As we said there is also `foo`_ that you can take advantage of ...
Yet another paragraph where we mention `foo`_ because...
.. _foo: http://example.org
There was a problem hiding this comment.
Ahh cool, didnt know that, will update !
There was a problem hiding this comment.
But actually the links are different so it shouldnt be an issue.
There was a problem hiding this comment.
In this case we shouldn't really call them both "here":
$ rm -rf docs/_build/
$ python setup.py build_sphinx
[...]
docs/tutorials.rst:2: WARNING: Duplicate explicit target name: "here".Better give them different names...
There was a problem hiding this comment.
There was a problem hiding this comment.
Ok cool! Updated!
docs/tutorials.rst
Outdated
| REANA is a reusable and reproducible research data analysis platform. It helps researchers to structure their input data, analysis code, containerised environments and computational workflows so that the analysis can be instantiated and run on remote compute clouds. REANA was born to target the use case of particle physics analyses, but is applicable to any scientific discipline. The system paves the way towards reusing and reinterpreting preserved data analyses even several years after the original publication. Find comprehensive documentation about the REANA project `here <https://reana.readthedocs.io/en/latest/>`__. |
There was a problem hiding this comment.
Ditto here, only one trailing _.
ioannistsanaktsidis
force-pushed
the
docs-build
branch
2 times, most recently
from
224c8a3 to
98542f6
Compare
Signed-off-by: Ioannis Tsanaktsidis <[email protected]>
ioannistsanaktsidis
force-pushed
the
docs-build
branch
from
98542f6 to
d1111b6
Compare
Signed-off-by: Ioannis Tsanaktsidis [email protected]