Skip to content

Repair ReadTheDocs broken links#861

Merged
Bachibouzouk merged 3 commits intodevfrom
fix/rtd-broken-links
Apr 14, 2021
Merged

Repair ReadTheDocs broken links#861
Bachibouzouk merged 3 commits intodevfrom
fix/rtd-broken-links

Conversation

@Bachibouzouk
Copy link
Copy Markdown
Collaborator

@Bachibouzouk Bachibouzouk commented Apr 14, 2021

Fix #856

Changes proposed in this pull request:

  • Fix internal and external links

The following steps were realized, as well (if applies):

  • Update the CHANGELOG.md
  • Apply black (black . --exclude docs/)

For more information on how to contribute check the CONTRIBUTING.md.

Bachibouzouk added 3 commits April 14, 2021 12:32
Some where external links to readthedocs,
better use :ref:`link text <internal label>`
Automatic Report
################
MVS has a feature to automatically `generate a PDF report <https://mvs-eland.readthedocs.io/en/latest/Installation.html#generate-pdf-report-or-an-app-in-your-browser-to-visualise-the-results-of-the-simulation>`__ that contains the main elements from the input data as well as the simulation results' data.
MVS has a feature to automatically :ref:`generate a PDF report <pdf-report-commands>` that contains the main elements from the input data as well as the simulation results' data.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this link doesn't work for me at the moment

The report also provides several plots which help to visualize the flows and costs.

Please, refer to the `report section <https://mvs-eland.readthedocs.io/en/latest/Installation.html#generate-pdf-report-or-an-app-in-your-browser-to-visualise-the-results-of-the-simulation>`__ for more information on how to setup and use this feature, or type
Please, refer to the :ref:`report section <pdf-report-commands>` for more information on how to setup and use this feature, or type
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

or this one

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are the same links, and it is probably related to your "Installation section which is empty locally. Did you try to refresh your browser?

@Bachibouzouk Bachibouzouk merged commit 938d506 into dev Apr 14, 2021
@Bachibouzouk Bachibouzouk deleted the fix/rtd-broken-links branch April 14, 2021 18:00
@smartie2076 smartie2076 mentioned this pull request May 31, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Some external links are broken in RTD

2 participants