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

Feature 1727 sphinx7 #1728

Merged
merged 5 commits into from
Nov 28, 2023
Merged

Feature 1727 sphinx7 #1728

merged 5 commits into from
Nov 28, 2023

Conversation

mbjones
Copy link
Member

@mbjones mbjones commented Nov 8, 2023

Support recent versions of python3 and sphinx 7 for admindoc builds. Test with ant admindoc. Older versions of sphinx should also work, starting with the first version that supported the styles key, but I had a hard time determining which version that was from the sphinx release notes. The python changes are to change SafeConfigParser (a python 2.7 fixture) which was replaced with ConfigParser and some methods renamed/refactored. I think any python after 3.2 would work, but I only tested against 3.10 and 3.11.

@mbjones mbjones added this to the 3.0.0 milestone Nov 8, 2023
@mbjones mbjones requested a review from artntek November 8, 2023 17:36
@mbjones
Copy link
Member Author

mbjones commented Nov 8, 2023

Oh, and by the way -- while I added the mermaid diagram from @doulikecookiedough , the build for that using sphinx.mermaid was not working, so I commented out the extension but left the mermaid code in the RST doc. We'll need to cycle back to getting the mermaid extension to work if we want to use it.

Copy link
Contributor

@taojing2002 taojing2002 left a comment

Choose a reason for hiding this comment

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

Looks great! But do you really mean to modify those 15 images files, Matt?

@mbjones
Copy link
Member Author

mbjones commented Nov 9, 2023

@taojing2002 yes, I intended to add the images. when you rerun the sphinx generator it generates new image files which are different from the old ones. So, by checking these in now, when other people regenerate them it shouldn't generate any changes.

@artntek
Copy link
Contributor

artntek commented Nov 21, 2023

can we merge this, @mbjones ?

@mbjones
Copy link
Member Author

mbjones commented Nov 21, 2023

Yes, feel free if its working for you. It worked for me, and I felt it would improve things. But its up to you and Jing if it looks like an improvement.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants