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

Docs fix img src paths #5225

Closed
wants to merge 2 commits into from
Closed

Conversation

bertsky
Copy link

@bertsky bertsky commented Jul 7, 2022

Follow-up to #5221, see #4080 for discussion.

This adds a docs/requirements.txt so that the readthedocs.org deployment will install a compatible version of mkdocs.

Moreover, to fix the image references in the user guide (which are broken in readthedocs.org deployments as well as Github pages, but somehow magically work when just building locally with mkdocs serve), making them resolve in all versions, I prefixed the absolute paths with ../../... Not sure if this is correct – perhaps it is an mkdocs / RTD / GH pages configuration issue, after all.

@bertsky
Copy link
Author

bertsky commented Jul 7, 2022

@Kathrin-Huber
Copy link
Contributor

We are not using read the docs anymore, don't we @solth?

@solth
Copy link
Member

solth commented Jul 18, 2022

We are not using read the docs anymore, don't we @solth?

I am sorry, I don't know.

@matthiaskissler
Copy link

Hi, the RTD documentation is obsolete and will be moved to Github Wiki in the near future; the user documentation part has already found a new home there, I still have to move the developer chapters to a fitting place within the Wiki pages.

@bertsky
Copy link
Author

bertsky commented Aug 23, 2022

@matthiaskissler understood, thanks for clarifying!

I presume we can therefore close?

@matthiaskissler
Copy link

Yes, this issue can be closed, thank you

@bertsky bertsky closed this Aug 25, 2022
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.

4 participants