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

Update documentation #200

Merged
merged 2 commits into from
Jun 6, 2023
Merged

Update documentation #200

merged 2 commits into from
Jun 6, 2023

Conversation

varunsh-xilinx
Copy link
Member

Summary of Changes

  • Update favicons
  • Change the image name for the main docs

Motivation

The use of the older 0.3.0 image with the docs from HEAD leads to confusion as the old image doesn't work with the current state of the docs. Using an new image name makes it clearer that users will need to build an image themselves to use the main docs instead of the versioned one.

Implementation

The favicon generation is from a website using the AMD logo. These are part of the theme and configured from conf.py.

The main version of the docs now uses the unreleased 0.4.0 version of the image that will be released next.

Notes

To build the docs, you'll need to rebuild the dev container or install sphinx-favicon in your existing container.

Signed-off-by: Varun Sharma <varun.sharma@amd.com>
Signed-off-by: Varun Sharma <varun.sharma@amd.com>
@gbuildx
Copy link
Collaborator

gbuildx commented Jun 6, 2023

Build successful!

@varunsh-xilinx varunsh-xilinx merged commit 663098b into main Jun 6, 2023
@varunsh-xilinx varunsh-xilinx deleted the update-docs branch June 6, 2023 19:24
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.

2 participants