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.

Sign up for GitHub

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

Jump to bottom

Update documentation theme #47

Merged
merged 6 commits into from
Jul 23, 2024
Merged

Update documentation theme #47

merged 6 commits into from
Jul 23, 2024

Conversation

Pennycook
Copy link
Contributor

Related issues

N/A

Proposed changes

  • Switch documentation theme and layout to match Code Base Investigator.
  • Rewrite the landing page to provide a gentler introduction to the library and P3 analysis.

@swright87, I'd appreciate it if you (and/or one of your students) could also take a look at this new text.

@Pennycook Pennycook added the documentation Improvements or additions to documentation label Jul 10, 2024
@Pennycook
Switch docs theme from alabaster to furo
86b3671 
Signed-off-by: John Pennycook <[email protected]>
@Pennycook
Add white background to P3 analysis flowchart
de3baa0 
This is a temporary fix to ensure the flowchart is visible in dark mode.

Signed-off-by: John Pennycook <[email protected]>
@Pennycook
Add subsections to TOC
82c1f57 
Signed-off-by: John Pennycook <[email protected]>
@Pennycook
Rename introduction => analysis
59b8d7f 
Signed-off-by: John Pennycook <[email protected]>
@Pennycook
Rewrite index page
be484f9 
Add installation instructions and an improved overview of the library.

Signed-off-by: John Pennycook <[email protected]>
@Pennycook
Update conf.py to satisfy pre-commit
b8f4ef4 
Signed-off-by: John Pennycook <[email protected]>
swright87
swright87 reviewed Jul 11, 2024
View reviewed changes
Copy link
Collaborator

@swright87 swright87 left a comment

Choose a reason for hiding this comment

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

I think this all looks good to me. There's a comment regarding the naming of the library to avoid potential name collisions, but feel free to ignore.

I'm unsure how to preview this on the GitHub page, but it seems clear that it should typeset nicely.

@Pennycook Pennycook requested a review from swright87 July 18, 2024 18:48
swright87
swright87 approved these changes Jul 22, 2024
View reviewed changes
Copy link
Collaborator

@swright87 swright87 left a comment

Choose a reason for hiding this comment

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

Looks good to me 👍

@Pennycook Pennycook mentioned this pull request Jul 23, 2024
Merged
@Pennycook Pennycook merged commit c4ba486 into intel:main Jul 23, 2024
3 checks passed
@Pennycook Pennycook deleted the update-docs-theme branch July 23, 2024 20:20
Pennycook added a commit that referenced this pull request Oct 18, 2024
@Pennycook
Update documentation
e5f1d77 
- Switches to furo theme (#47)
- Updates examples to new style (#51, #67)
- Adds new examples (#54, #55, #58)
- Marks the documentation unstable (#72)

Signed-off-by: John Pennycook <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@laserkelvin laserkelvin laserkelvin approved these changes

@swright87 swright87 swright87 approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Pennycook @swright87 @laserkelvin