Comments (8)
- I created #295, crate/crate-tutorials#70 and crate/crate-jdbc#346 in order to work towards this goal.
- I believe the dependencies on
crate
andcroud
will not do any harm. - Would leaving project-specific dependencies like
sphinx-csv-filter
forcrate
orsphinx-argparse
forcroud
do any harm to this plan?
from crate-docs-theme.
- sweet!! thanks so much
- which dependencies? (i.e., what file or files are you referencing?)
- yeah I think that's fine. should be no problem to leave those project-specific deps in there
from crate-docs-theme.
@norosa: Do you believe we can close this ticket or is there some more work to do which I might be missing?
from crate-docs-theme.
@amotl take a look and let me know what you think. I'm happy to create the PRs and do the work to fix this issue. but I also thought you might like to take a shot? (i.e., to share knowledge/experience)
from crate-docs-theme.
The crate-docs-theme should specify all requirements in the setup.py file and the Sphinx project-specific docs/requirements.txt file should only list a single dependency: crate-docs-theme (not pinned to any version, so the latest is always used).
I second this, let's make [1] the single source of truth. Shall we explictly say sphinx>=3.5.4,5
in setup.py
then in order to retain the flexibility to evaluate it on Sphinx 4?
[1] https://github.com/crate/crate-docs-theme/blob/main/setup.py
from crate-docs-theme.
In this context, I would also like to reference crate/crate-docs#52.
from crate-docs-theme.
- which dependencies? (i.e., what file or files are you referencing?)
Yeah, I actually meant those referenced at 3., apart from crate-docs-theme
, at:
[2a] https://github.com/crate/crate/blob/master/docs/requirements.txt
[2b] https://github.com/crate/croud/blob/master/docs/requirements.txt
All set!
from crate-docs-theme.
@amotl thanks for all the work!
from crate-docs-theme.
Related Issues (20)
- Version chooser regression HOT 1
- Version chooser: Stay on the same page when switching versions HOT 10
- Wishlist: Add basic extension to aggregate change log pages HOT 3
- Improving feedback and version choosers HOT 11
- Improve rendering of sphinx-togglebutton
- "Edit page" does not work on repositories using the "main" branch HOT 1
- Menu items got lost HOT 1
- Fix package metadata
- Hide new feedbackbox on the search page HOT 1
- Page tools rendering glitch on CrateDB Reference, version 3.3
- Search: Set focus to the query field
- Using `sphinxext-photofinish` for creating responsive images HOT 1
- Use MyST-NB for Jupyter Notebook Publishing
- SQL-99 RTD URL errors HOT 2
- New <h1> headline font: Montserrat HOT 8
- Documentation feedback on /docs/links.md HOT 2
- Move search button to the top right corner HOT 1
- Missing `index.html` within link generated to designate the canonical URL HOT 2
- CrateDB Guide Configuration: Do not set `language = ""` HOT 1
- Documentation feedback: Links to pages are broken after refactoring HOT 2
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 crate-docs-theme.