UAL-RE / redata-docs

A repo to serve general documentation regarding ReDATA software
https://redata.readthedocs.io/
MIT License
1 stars 1 forks source link

close Issue #16 #19

Closed yhan818 closed 2 years ago

yhan818 commented 2 years ago

close Issue #16

yhan818 commented 2 years ago

No worries.

I have already forked an instance and compiled /checked the Sphinx code. It is basically a documentation generator using predefined configuration / syntax. Over the weekend, I did a bunch of tests. I can show you how things work.

On Mon, May 9, 2022 at 8:08 AM Fernando Rios @.***> wrote:

@.**** requested changes on this pull request.

I recommend doing a bit of research on how reStructuredText works (homework for me too)

In source/repos.rst https://github.com/UAL-RE/redata-docs/pull/19#discussion_r868120000:

@@ -51,7 +51,7 @@ Repositories details +-----------------------------------------------+----------------------------+---------------+-------------------------------+-------------+---------------------------------------------+ | :ual-re:ReBACH <ReBACH> | N/A | TBC | README | main | TBD | +-----------------------------------------------+----------------------------+---------------+-------------------------------+-------------+---------------------------------------------+ -| :ual-re:ReQUIAM <ReQUIAM> | |ReQUIAM_version| | CHANGELOG | README | master | N/A | +| :ual-re:ReQUIAM <ReQUIAM> | |ReQUIAM_version| | CHANGELOG | :rtd:RTD <requiam> | master | N/A |

Won't this break the cross references? I'm not a reStructuredText expert but I think that that the order of the anonymous hyperlink targets matters. (i.e., the order of the references with the double underscore is now different since README was deleted. This may break the rest of the links following this change) Please test and verify

— Reply to this email directly, view it on GitHub https://github.com/UAL-RE/redata-docs/pull/19#pullrequestreview-966309011, or unsubscribe https://github.com/notifications/unsubscribe-auth/ACCPLUPQSOCOCBCJHBA2AV3VJES75ANCNFSM5VJOKWXA . You are receiving this because you authored the thread.Message ID: @.***>

zoidy commented 2 years ago

I've re-opened the issue #16 as the changes seem to have broken the references