PySpice icon indicating copy to clipboard operation
PySpice copied to clipboard

Wrong target in hyperlink for FAQ in README.rst

Open cyber-g opened this issue 4 years ago • 2 comments

Environment (OS, Python version, PySpice version, simulator)

Online with a regular web browser

Steps to reproduce the behaviour

Load the PySpice project page : https://github.com/FabriceSalvaire/PySpice or the README file : https://github.com/FabriceSalvaire/PySpice/blob/master/README.rst

And click on the hyperlink of the FAQ :

Implemented raw spice pass through (see User FAQ)

Expected Behaviour

The User FAQ should be loaded

Actual Behaviour

Error 404.

Solution

The right target is : https://github.com/FabriceSalvaire/PySpice/blob/master/doc/sphinx/source/faq.rst

(I will submit shortly a Pull request with the solution)

cyber-g avatar Aug 03 '20 14:08 cyber-g

I dug a little bit more and figured out that target links are not pointing to github architecture directory but are designed for the documentation website (https://pyspice.fabrice-salvaire.fr)

That being said, the link in question does not work on the documentation site either.

Implemented raw spice pass through (see User FAQ)

(found at News )

Since, I am not sure about the right approach to fix the issue, I will not finally propose a pull request. I would actually need some guidance

cyber-g avatar Aug 03 '20 15:08 cyber-g

Should be due to the fact news.rst is used to generate the doc and README which are hosted on two different hosts ...

FabriceSalvaire avatar May 07 '21 12:05 FabriceSalvaire