Skip to content

Comments

Doc links update#6

Merged
sgiarols merged 21 commits intomainfrom
doc-links-update
Mar 16, 2022
Merged

Doc links update#6
sgiarols merged 21 commits intomainfrom
doc-links-update

Conversation

@alexanderkell
Copy link
Contributor

@alexanderkell alexanderkell commented Mar 11, 2022

Description

Updates the dead links in the documentation to the case studies with the csv files.

Fixes # (issue)

Type of change

  • New feature (non-breaking change which adds functionality)
  • Optimization (non-breaking, back-end change that speeds up the code)
  • Bug fix (non-breaking change which fixes an issue)
  • Breaking change (whatever its nature)

Key checklist

  • All tests pass: $ python -m pytest
  • The documentation builds and looks OK: $ python setup.py build_sphinx

Further checks

  • Code is commented, particularly in hard-to-understand areas
  • Tests added that prove fix is effective or that feature works

@alexanderkell alexanderkell requested a review from sgiarols March 11, 2022 15:46
@alexanderkell
Copy link
Contributor Author

alexanderkell commented Mar 11, 2022

This PR solves #7 I believe

Copy link
Collaborator

@sgiarols sgiarols left a comment

Choose a reason for hiding this comment

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

  • overview.rst: foresight could be an inline figure
  • installation routine to be updated
  • technodata.rst has a few links not displayed properl(inputs-agents and existing_capacity)
  • inputs_csv.rst has not updated links ('inputs/timeslices' ad 'inputs/regions')
  • docs/add-solar file seems redundant
  • API is not built

@alexanderkell
Copy link
Contributor Author

alexanderkell commented Mar 14, 2022

Thanks @alexanderkell, regarding this:
Could you explain what you mean by "overview.rst: foresight could be an inline figure"? It looks okay to me on https://muse-docs.readthedocs.io/en/latest/overview.html#foresight-in-muse

I was wondering whether the figure can be on the same page rather than on a separate link (but it is a minor question)

@alexanderkell
Copy link
Contributor Author

@sgiarols, how do you view the documentation as built with GitHub actions? The API builds locally for me.

@sgiarols
Copy link
Collaborator

@sgiarols, how do you view the documentation as built with GitHub actions? The API builds locally for me.

On readthedocs, the links are not working.

@sgiarols sgiarols merged commit e8322a8 into main Mar 16, 2022
@sgiarols sgiarols deleted the doc-links-update branch March 16, 2022 07:47
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.

Update the documentation

2 participants