Comments (15)
from streamz.
I'm going to use doctr if that is ok.
from streamz.
Why not readthedocs?
from streamz.
I guess I'm more familiar with doctr. They also enumerate a couple of reasons to use it over readthedocs.
from streamz.
Neither of the reasons listed seem very motivating to me:
You are limited in what you can install in Read the Docs. Travis lets you run arbitrary code, which may be necessary to build your documentation.
Read the Docs deploys to readthedocs.io. Doctr deploys to GitHub pages. This is often more convenient, as your docs can easily sit alongside other website materials for your project on GitHub pages.
Some reasons I like readthedocs
- It has been around for a long time and has become something of a standard
- It handles latest and stable versions of documentation, and has nice history about build failures
- It is maintained by dedicated developers
However, if I'm going to push readthedocs then I should probably also be willing to put in some effort to set things up.
I suspect that in both cases we're just going to be pushing rst or md files to a docs/
directory in the master branch, yes?
from streamz.
Ok, yes if you don't mind I've not used readthedocs before. Yes, both are standard docs/
based things. As a side note one thing that I've been looking at doctr to do is render latex documents for collaborators. This way there is a CI based standard so even if you are missing a library or some other resource you can always get your paper rendered.
from streamz.
Ah, right, so it looks like I started down this path before but stopped because I ran into the naming issue. What do we call this thing? A few classes of options:
- streamspy or some not-yet-taken alternative involving streams and python
- Some novel name
- dask-streams (which sort of forces me to make a dask-powered version at some point)
I have a slight inclination towards 3, mostly because it avoids creativity
from streamz.
I personally like 3, since it means that we might get a dask-powered version at some point (which I'm happy to help out on, its on my todo list but its not so near the top). I know @ordirules was working on getting the streams
name on pypi since the existing library seems to be defunct.
from streamz.
I contacted the owner of the name by email but no response: https://github.com/ztane. I sent out this email about 2 months ago.
The package has had no activity since over two years ago.
I suggest going higher up. I have not done so, but I could try to ask in pypi if it's possible to change ownership of a library and delete it and start fresh again.
from streamz.
I wasn't sure how to go about this, so I asked a general question on the forum. Is there a better way?
from streamz.
from streamz.
ok, great. so where will it land? (dask-streams.github.io ? )
from streamz.
Naming discussion moved to #35
from streamz.
I have alternately used readthedocs and doctr for a couple projects. I think readthedocs is perfectly good for pure-Python projects like dask-streams, and it might be nice to stick with it for consistency with the rest of the dask mini-ecosystem. I would be glad to help with documentation-writing, wherever it lands.
from streamz.
I'm closing this issue, as it was really about the creation of web docs. However, the push for writing user docs continues!
from streamz.
Related Issues (20)
- missing positional argument: 'topic' in to_mqtt HOT 5
- How to parametrize stream/pipeline creation? HOT 2
- Passing Username and Password to from_mqtt() HOT 4
- Dynamically add upstreams to zip HOT 2
- Dropping `pkg_resources`
- AttributeError: 'Output' object has no attribute '_ipython_display_' HOT 3
- flatten doesn't work with iterables without defined length HOT 2
- visualizing streams and changing variables during runtime HOT 5
- Is it possible to use event time/syntethic time rather than system time? HOT 2
- Time based lookback window? HOT 1
- Streamz not working in Jupyterlite
- Collect does not allow awaitable sinks
- Quickstart lacks conda/environments/streamz_dev.yml HOT 6
- Hello from LorryStream and Kotori / Streamz is cool HOT 1
- Add pytest fixture to clean up the IO loop HOT 4
- Streamz hvplot resets zoom and pan on each update HOT 3
- streamz's typing system can't work properly in vscode HOT 2
- Streamz with websocket not steaming any data HOT 5
- Parallel streams with buffers HOT 3
- Is streamz not maintained anymore? What happened to cuStreamz? HOT 9
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 streamz.