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

📚 Multiple docs fixes and improvements #2009

Merged
merged 1 commit into from
Oct 17, 2024

Conversation

daquinteroflex
Copy link
Collaborator

@daquinteroflex daquinteroflex commented Oct 9, 2024

Live at https://docs.flexcompute.com/projects/tidy3d/en/demo-test-fix_docs_builds/development/documentation.html

  • Fixes https://flow360.atlassian.net/browse/SCEM-7774
  • Faster docs build
  • Reduces number of sphinx warnings and docs issues
    • More consistent title levels
    • Adding missing documentation onto stub files
  • Adds the latest lectures on the webcenter
  • Ugly attr directory inclusion on each class in the pre/2.7 docs

Supersedes #1745

image

@daquinteroflex daquinteroflex force-pushed the demo/test/fix_docs_builds branch from d4b7e2a to 487966b Compare October 11, 2024 13:02
@daquinteroflex
Copy link
Collaborator Author

Hi @tylerflex, just fyi you've already reviewed/approved most of this in #1745 . This PR does the requested Jira fix and also removes the stuff that didn't work from the other old PR of the multiple docs improvements.

Copy link
Collaborator

@tylerflex tylerflex left a comment

Choose a reason for hiding this comment

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

Thanks! it looks good to me. I'm not sure if you need someone else on the team to take a look? as I couldn't understand everything here. but as long as it fixes the issues I think it's good to me!

@daquinteroflex
Copy link
Collaborator Author

Sounds good I've added @jwang1231 who requested the Jira fix.

@jwang1231
Copy link

Double checked. The duplicated 'Documentation' has been removed from the tree node.

@daquinteroflex
Copy link
Collaborator Author

Nice, merging now and so this will be live on the next docs release.

@daquinteroflex daquinteroflex merged commit 29bafce into develop Oct 17, 2024
17 checks passed
@daquinteroflex daquinteroflex deleted the demo/test/fix_docs_builds branch October 17, 2024 14:09
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.

3 participants