-
Notifications
You must be signed in to change notification settings - Fork 37
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: forward-ports from 3.x #256
Commits on Jul 11, 2024
-
Pin specific version of Jinja2
Before this change, the docs failed to build with the following error: ImportError: cannot import name 'environmentfilter' from 'jinja2' A fix to this problem is to explicitly pin Jinja2 version. (cherry picked from commit cdaf75a)
Configuration menu - View commit details
-
Copy full SHA for 8659c15 - Browse repository at this point
Copy the full SHA 8659c15View commit details -
docs: update dynamic slug Add back index.md Move custom slug to a separate PR Fix typo (cherry picked from commit 8feeb20)
Configuration menu - View commit details
-
Copy full SHA for f8c3c9d - Browse repository at this point
Copy the full SHA f8c3c9dView commit details -
Add Java Driver 4.x branches to documentation
Add Java Driver 4.x branches to the list of generated documentation and bump the LATEST_VERSION variable. (cherry picked from commit 76f7715)
Configuration menu - View commit details
-
Copy full SHA for d92e6df - Browse repository at this point
Copy the full SHA d92e6dfView commit details -
(cherry picked from commit d2e261b)
Configuration menu - View commit details
-
Copy full SHA for f4d4d79 - Browse repository at this point
Copy the full SHA f4d4d79View commit details -
fix: redirection to api reference
Fix javadoc redirect Fix (cherry picked from commit a9fcffb)
Configuration menu - View commit details
-
Copy full SHA for 79eccb7 - Browse repository at this point
Copy the full SHA 79eccb7View commit details -
(cherry picked from commit 7399a0a)
Configuration menu - View commit details
-
Copy full SHA for 680de75 - Browse repository at this point
Copy the full SHA 680de75View commit details -
Add java-driver.docs.scylladb.com replacements
The links in our documentation have a hardcoded version number in them: https://java-driver.docs.scylladb.com/scylla-3.11.2.x/api/ https://docs.datastax.com/en/drivers/java/3.11/com/datastax/driver/core/Cluster.html Therefore, a replacement rule is needed to replace the version to a correct version for a specific driver version we render the docs for. Before this change, only datastax links were replaced. After this change, java-driver.docs.scylladb.com links are also replaced. (cherry picked from commit 8cd4d8e)
Configuration menu - View commit details
-
Copy full SHA for 1e2ed28 - Browse repository at this point
Copy the full SHA 1e2ed28View commit details -
Fix java-driver.docs.scylladb.com replacement
(cherry picked from commit 511573f)
Configuration menu - View commit details
-
Copy full SHA for d8345c1 - Browse repository at this point
Copy the full SHA d8345c1View commit details -
Add 4.14.1.x and 4.15.0.x to generated docs
Add 4.14.1.x and 4.15.0.x releases to the list of versions to generate the docs for. (cherry picked from commit d296895)
Configuration menu - View commit details
-
Copy full SHA for b0a57a5 - Browse repository at this point
Copy the full SHA b0a57a5View commit details -
docs: update conf.py docs: update conf.py docs: Update conf.py docs: update conf.py docs: Update conf.py docs: update conf.py (cherry picked from commit 0d1f1c4)
Configuration menu - View commit details
-
Copy full SHA for 235c6ac - Browse repository at this point
Copy the full SHA 235c6acView commit details -
docs: test docs: add skip warnings option (cherry picked from commit 2601b78)
Configuration menu - View commit details
-
Copy full SHA for 208efa6 - Browse repository at this point
Copy the full SHA 208efa6View commit details -
(cherry picked from commit 51ff0d5)
Configuration menu - View commit details
-
Copy full SHA for 63ee0f9 - Browse repository at this point
Copy the full SHA 63ee0f9View commit details -
(cherry picked from commit 7ab2a8f)
Configuration menu - View commit details
-
Copy full SHA for dd8c03b - Browse repository at this point
Copy the full SHA dd8c03bView commit details
Commits on Jul 12, 2024
-
docs: wrap long line for better readability
Signed-off-by: Kefu Chai <[email protected]> (cherry picked from commit 6a5d3a7)
Configuration menu - View commit details
-
Copy full SHA for 963151e - Browse repository at this point
Copy the full SHA 963151eView commit details -
(cherry picked from commit 8dea9e2)
Configuration menu - View commit details
-
Copy full SHA for 1010682 - Browse repository at this point
Copy the full SHA 1010682View commit details -
(cherry picked from commit 9eedcac)
Configuration menu - View commit details
-
Copy full SHA for 9b7c7f7 - Browse repository at this point
Copy the full SHA 9b7c7f7View commit details -
docs: triggered when on push to scylla-3.x
this change is not cherry-picked from 4.x, as it is specific to scylla-3.x branch. Signed-off-by: Kefu Chai <[email protected]>
Configuration menu - View commit details
-
Copy full SHA for eb97246 - Browse repository at this point
Copy the full SHA eb97246View commit details -
(cherry picked from commit efe5101)
Configuration menu - View commit details
-
Copy full SHA for db334b9 - Browse repository at this point
Copy the full SHA db334b9View commit details
Commits on Jul 13, 2024
-
docs: suppress warning from autosectionlabel
to silence the warning from sphinx, as we have two "Dropwizard Metrics" sections in manual/core/metrics/index.md: ``` /home/kefu/dev/scylla-java-driver/docs/_source/manual/core/metrics/index.md:291: WARNING: duplicate label manual/core/metrics/index:dropwizard metrics, other instance in /home/kefu/dev/scyll a-java-driver/docs/_source/manual/core/metrics/index.md ``` and the warning breaks the "make test". so let's suppress the warning at this moment. Signed-off-by: Kefu Chai <[email protected]>
Configuration menu - View commit details
-
Copy full SHA for 04d1a58 - Browse repository at this point
Copy the full SHA 04d1a58View commit details -
manual: correct the codeblock directive
it should start with three backticks not four of them. otherwise sphinx warns like: ``` /home/kefu/dev/scylla-java-driver/docs/_source/manual/mapper/daos/getentity/index.md:111: WARNING: Lexing literal_block '@GetEntity\nProduct asProduct(Row row);\n\n@GetEntity\nProduct firstR owAsProduct(ResultSet resultSet);\n```\n\n' as "java" resulted in an error at token: '`'. Retrying in relaxed mode. ``` in this change, let's use three backticks. and the warning disappears. Signed-off-by: Kefu Chai <[email protected]>
Configuration menu - View commit details
-
Copy full SHA for 3311fc8 - Browse repository at this point
Copy the full SHA 3311fc8View commit details