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

changed html_logo #901

Closed
wants to merge 1 commit into from
Closed

changed html_logo #901

wants to merge 1 commit into from

Conversation

svenkat19
Copy link

No description provided.

@hildeweerts
Copy link
Contributor

hildeweerts commented Jul 14, 2021

Hi @svenkat19, thank you for the PR!

Did you build the website locally to verify whether the logo shows up? Could you please add a screenshot so we can check that it looks as expected?

PS. We usually add to a description something like "closes #...", "fixes #...", or "resolves #..." with the number of the associated issue. In that way the issue gets closed automatically when we merge the PR (more info here)

@svenkat19
Copy link
Author

Hi @svenkat19, thank you for the PR!

Did you build the website locally to verify whether the logo shows up? Could you please add a screenshot so we can check that it looks as expected?

PS. We usually add to a description something like "closes #...", "fixes #...", or "resolves #..." with the number of the associated issue. In that way the issue gets closed automatically when we merge the PR (more info here)

Could you please help me out on how to build the website, I am quite new to this!

@hildeweerts
Copy link
Contributor

Sure!

You first need to make sure that you have installed the packages that are required to build the documentation. You can find these in this file but you can also install them all automatically using the python script as described in the first paragraph of this page.

Then you can run make doc from the root directory of the fairlearn repository after which the website is generated in the docs/_build directory. This will take a while, usually around 15min if it's the first time you're building the website.

I hope this helps - let me know if you have any further questions!

@svenkat19
Copy link
Author

Sure!

You first need to make sure that you have installed the packages that are required to build the documentation. You can find these in this file but you can also install them all automatically using the python script as described in the first paragraph of this page.

Then you can run make doc from the root directory of the fairlearn repository after which the website is generated in the docs/_build directory. This will take a while, usually around 15min if it's the first time you're building the website.

I hope this helps - let me know if you have any further questions!

image
I built the website. Is this okay??

@hildeweerts
Copy link
Contributor

Hmm.. it seems my proposed solution was not the correct one... When we change the url like this the image cannot be found while building the docs - I got this warning: WARNING: logo file '/images/fairlearn_full_color.png' does not exist. I will update the issue and think a bit further on how this might be solved.

@hildeweerts
Copy link
Contributor

Hi @svenkat19. It turns out that this is an issue with sphinx that can be fixed by updating to sphinx 4.1.1 once the folks at sphinx release that version (see my updates to #899).

I am so sorry for not checking this in more detail before assigning the issue to you! :( I do hope that it was a good learning experience for you, despite the perhaps disappointing outcome.

I will close this PR now as it is no longer necessary.

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.

None yet

2 participants