Comments (6)
I don't believe these changes are necessary.
To build the documentation, you're supposed to use the Makefile - make setup
to create the virtualenv and make build_docs
to build the docs. make serve_docs
will serve them with http.server
. You shouldn't, in fact, need sphinx-build
at all.
But either way, I don't want to make these changes because they depend on paths. Instead, I want to depend on the module being installed into the current environment.
If you have some particular reason to use sphinx-build
over make build_docs
and can convince me, then we can work together to migrate. But you shouldn't need to mess with sys.path if pyee is installed in your env.
from pyee.
As long as in your Makefile to the sphinx-build
parameters will be added -n
option you will be able to see the same warning.
That patch which alters sys.path
guaranteees that documentation will be generated against code from source tree and not against installed pyee
.
If you don't care about such detail that is fine. I'll keep that patch in build procedure.
If you have some particular reason to use sphinx-build over make build_docs and can convince me,
Reason is that this Makefile is not needed .. in other words that reason it is just KISS pronciple.
from pyee.
In that case, I'm going to close this issue, as I have no intention of accepting a patch like this.
from pyee.
In that case, I'm going to close this issue, as I have no intention of accepting a patch like this.
Reported warnings have nothing to do with reported warnings. That patch only improves the copy.py file to guarantee that it will produce ALWAYS documentation not out of installed module but out of code in source tree.
Did you ever try to use that -n
switch to reproduce the issue?
from pyee.
from pyee.
Wrong references are mot about paths ..
from pyee.
Related Issues (20)
- type-safe TypedEventEmitter implementation HOT 1
- Wrap captured exceptions in a PyeeError HOT 3
- [Regression]: EventEmitter.listeners("foo") throws if no listener exists HOT 2
- Regression: Docs on RTD are Broken HOT 1
- Automate RTD Build HOT 1
- Adopt pyproject.toml HOT 1
- Add .readthedocs.yaml HOT 1
- The 9.0.4 release in pypi isn't tagged in git HOT 2
- 9.0.4: pytest warnings HOT 5
- async lock error HOT 1
- AsyncIOEventEmitter should keep a reference to scheduled futures HOT 5
- "port of Node.js EventEmitter" not entirely accurate
- refactor EE import paths
- Handle for the async functions? HOT 4
- Using in Multiple Scripts HOT 1
- OSX Issue module 'select' has no attribute 'epoll' HOT 1
- Recommend error handling HOT 5
- Emit can be error HOT 1
- pyee release 9.0.x
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 pyee.