Comments (2)
TheFriendlyCoder
commented on August 25, 2024
Oh, and we are using the latest version of Sphinx (4.0.1) and the apidocs plugin (0.3.0) when testing. Also, as is evidenced by the example code, we are using the Google style doc strings as supported by the napoleon extension provided by Sphinx as well.
I also took some time to do some additional testing across several different versions of Sphinx, and was able to reproduce this problem as far back as v2.2.0. It is possible that older version of Sphinx may have provided similar results as well. So this appears to be a long standing bug, which I'm surprised hasn't been reported or fixed yet.
from apidoc.
TheFriendlyCoder
commented on August 25, 2024
Pretty sure I've reported this bug in the wrong project. I've reworked this into a bug report for Sphinx, under the autodocs extension here: sphinx-doc/sphinx#9250
from apidoc.
Related Issues (12)
- validate function/method params against docstrings HOT 1
- Passing multiple apidoc_module_dir's
- Cython modules that use __init__.pyx instead of __init__.py are broken HOT 1
- Cannot include private methods with apidoc_extra_args HOT 5
- 0.3.0: test suite fails HOT 2
- Is it possible to run example code to generate an image? HOT 1
- Add support for Python 3.12 HOT 1
- Support templating HOT 5
- WARNING: Inline literal start-string without end-string. HOT 2
- Support more config options HOT 2
- Call to `pbr.version.VersionInfo` raises exception on import HOT 7
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 apidoc.