Giter VIP home page Giter VIP logo

Comments (7)

stephenfin avatar stephenfin commented on September 22, 2024 1

Oh, wait, you're referring to the docs for this project. Apologies. I'll take a look now

from sphinx-click.

stephenfin avatar stephenfin commented on September 22, 2024

Can you confirm if this was an issue with previous versions?

from sphinx-click.

kloczek avatar kloczek commented on September 22, 2024

It was et least in last 3-4 months (I had no time to report that .. sorry)

from sphinx-click.

stephenfin avatar stephenfin commented on September 22, 2024

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.

kloczek avatar kloczek commented on September 22, 2024

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.

stephenfin avatar stephenfin commented on September 22, 2024

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.

kloczek avatar kloczek commented on September 22, 2024

Thank you 😄

from sphinx-click.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.