Comments (7)
Oh, wait, you're referring to the docs for this project. Apologies. I'll take a look now
from sphinx-click.
Can you confirm if this was an issue with previous versions?
from sphinx-click.
It was et least in last 3-4 months (I had no time to report that .. sorry)
from sphinx-click.
No problem. I haven't seen this issue personally (and I built all my documentation with the -W
flag so I'd have noticed). If possible, could you find the specific version that this broke on? That'll give me something to work with as I try to investigate this. Alternatively, could you give me a minimal reproducer?
from sphinx-click.
Tested and it still needs one small patch
--- a/docs/conf.py~ 2022-04-26 17:55:14.000000000 +0000
+++ b/docs/conf.py 2022-04-26 17:56:41.179553922 +0000
@@ -5,6 +5,7 @@
import os
import sys
+sys.path.insert(0, os.path.abspath('..'))
sys.path.insert(0, os.path.abspath('../examples'))
# -- General configuration ------------------------------------------------
With that patch is possible now generate documentation out of source tree and without tox (which is shorter 😄 )
+ /usr/bin/sphinx-build -n -T -b man docs build/sphinx/man
Running Sphinx v4.5.0
making output directory... done
building [mo]: targets for 0 po files that are out of date
building [man]: all manpages
updating environment: [new config] 7 added, 0 changed, 0 removed
reading sources... [100%] usage
/home/tkloczko/rpmbuild/BUILD/sphinx-click-4.0.0/docs/changelog.rst:4: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: 'ChangeLog'.
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... python-sphinx-click.3 { installation usage contributing changelog examples/index examples/commandcollections } done
build succeeded, 1 warning.
Nevertheless .. thank you 😄
from sphinx-click.
Tested and it still needs one small patch
--- a/docs/conf.py~ 2022-04-26 17:55:14.000000000 +0000 +++ b/docs/conf.py 2022-04-26 17:56:41.179553922 +0000 @@ -5,6 +5,7 @@ import os import sys +sys.path.insert(0, os.path.abspath('..')) sys.path.insert(0, os.path.abspath('../examples')) # -- General configuration ------------------------------------------------With that patch is possible now generate documentation out of source tree and without tox (which is shorter smile )
Done 🙂
from sphinx-click.
Thank you 😄
from sphinx-click.
Related Issues (20)
- add build-backend to pyproject.toml
- Missing detection of envvars via auto_envvar_prefix-option HOT 1
- Extend \b rewrapping to click options HOT 2
- Nested subcommands improvement HOT 1
- Supports `.. click:example::` and `.. click:run::` directives HOT 3
- Option defaults with escape characters don't render correctly HOT 5
- <class ‘click.core.Command’>” of type “scripts.my module:mycommand” is not click.Command or click.Group.”click.BaseCommand” HOT 1
- metavar in docs does not match metavar in help output HOT 2
- Missing show_default detection via context_settings. HOT 1
- _format_envvars does not seem to support auto_envvar_prefix on group HOT 1
- remove "Required argument" from every click arg HOT 1
- Sphinx_click not working with Read The Docs HOT 2
- Issue with sphinx 7.0 HOT 2
- "\b" prevents formatting HOT 1
- Support myst-parser HOT 3
- Document sub-command only
- Show list of commands HOT 1
- Tests fail with click 8.1.x HOT 1
- :nested: full doesn't work anymore HOT 3
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 sphinx-click.