Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Class Index link broken #114

Closed
eibar-flores opened this issue Feb 26, 2024 · 1 comment
Closed

Class Index link broken #114

eibar-flores opened this issue Feb 26, 2024 · 1 comment
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@eibar-flores
Copy link
Collaborator

Describe the bug
The class index card in BattINFO main entry page is broken. The Class Index in the NavBar works, but the one at the bottom of the page does not work (at the grid item card). I believe it is because in ./sphinx/index.rst the .. grid-ite--card:: object directs to electrochemistry.html which does not exist in the repo. Instead it should lead to battinfo.html which I believe is generated as the sphinx documentation is built.

Before trying myself though, I would like to know how the interaction between battinfo, electrochemistry-domain and battery-domain is set up; i dont want to make a change that breaks everything else.

To Reproduce
Steps to reproduce the behavior:

  1. Go to BattINFO documentation
  2. On the top NavBar Click on 'Class Index.' It works as intended.
  3. Scroll down to 'Check out these resources to get started!'
  4. Click on the card "Class Index"
  5. See error

Expected behavior
Redirection to BattINFO Class Index as when the NavBar is clicked.

@eibar-flores eibar-flores added bug Something isn't working documentation Improvements or additions to documentation labels Feb 26, 2024
@eibar-flores
Copy link
Collaborator Author

The issue is only in BattINFO and in Domain-battery. In all three repos (including domain-electrochemistry), the the .. grid-ite--card:: object in ./sphinx/index.rst directs to electrochemistry.html. The issue might be solved by just simply linking .. grid-ite--card:: to battinfo.html in BattINFO, and to battery.html in domain-battery.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants