Comments (4)
Sphinx >= 4.2.0
should be fine according to the referenced issue.
However, our requirements.txt currently limits sphinx to be < 4.1.0 due to breahte/exhale PRs (referneced in requirements.txt
). These have been merged, so increasing breathe to >= 4.31
would also be required if I've correctly understood the release / PR timelines.
This will need some testing.
Probably worth expanding our docs build CI to test min/max supported python versions too (3.7 and 3.10 currently? 3.11 soon?) to catch these issues (maybe a latest
python would be nice, not sure how feasible this is without a lot of effort.
from flamegpu2-docs.
Breathe added support for Sphinx 5.0 in the latest release (4.34.0, 2022-06-20).
None of the breaking sphinx 5.0 changes look like they should impact us at a glance.
Exhale >= 0.3.2 requires pyhton >= 3.7 (i.e. dropping 3.6), but otherwise doesn't seem to require specific breathe / sphinx versions / conflicts (atleast based on its change log).
Moving to Sphinx >= 5.0 and Breateh >= 4.34 plus updating CI to use python 3.7 and 3.11 seems like it should be fine and will pull in a number of fixes.
from flamegpu2-docs.
I have tested on Sphinx 5.0 and all seems fine.
from flamegpu2-docs.
This should actually be Breathe >= 4.31 but bumping to 4.34 is no issue.
from flamegpu2-docs.
Related Issues (20)
- Critical title level warnings HOT 4
- Documentation landing page
- Sidebar link order
- Windows CMake guide, how to use non-default CUDA version HOT 2
- Add VSCode debugging example(s) HOT 1
- Github Actions node deprecation warnings
- Document cleanup() HOT 1
- JSON is no longer strictly valid JSON
- Message list persistence
- Improve documentation around how to use agent states
- Vis Agent State hiding HOT 1
- `newProperty` in Agent Variables documentation
- Array msg, how to get message index within array during iteration
- CI: purge `gh-pages` on each publication
- Beginner's feedback for improving documentation HOT 6
- Python agent sort code example wrong
- CMake: flamegpu_add_library
- AgentDescription::setSortPeriod(0) is not documented
- Improve coverage of agent state transitions.
- API Docs not currently built on docs website
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from flamegpu2-docs.