Skip to content

Commit 5dc7fb1

Browse files
committed
temporary changes
rebase or delete later on
1 parent 0f016f0 commit 5dc7fb1

File tree

15 files changed

+19
-13
lines changed

15 files changed

+19
-13
lines changed

docs/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ SOURCEDIR = _source
1010
PAPEROPT_a4 = -D latex_paper_size=a4
1111
PAPEROPT_letter = -D latex_paper_size=letter
1212
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SOURCEDIR)
13-
TESTSPHINXOPTS = $(ALLSPHINXOPTS) -W --keep-going
13+
TESTSPHINXOPTS = $(ALLSPHINXOPTS) -W --keep-going -v
1414
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SOURCEDIR)
1515

1616
.PHONY: all

docs/pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ authors = ["Java Driver Contributors"]
88
python = "^3.9"
99
pyyaml = "6.0.1"
1010
pygments = "2.15.1"
11+
recommonmark = "0.7.1"
1112
redirects_cli ="~0.1.3"
1213
sphinx-scylladb-theme = "~1.7.2"
1314
sphinx-sitemap = "2.5.1"

docs/source/conf.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,7 @@
9999
'scylla-4.13.0.x',
100100
'scylla-4.14.1.x',
101101
'scylla-4.15.0.x',
102+
'scylla-4.18.1.x'
102103
]
103104
suppress_warnings = ["ref.any", "myst.header","myst.xref_missing","autosectionlabel"]
104105

@@ -186,5 +187,9 @@ def setup(app):
186187
r'java-driver.docs.scylladb.com\/(.*?)\/': "java-driver.docs.scylladb.com/" + current_slug + "/"
187188
}
188189
app.add_config_value('replacements', replacements, True)
190+
app.add_config_value('recommonmark_config', {
191+
'enable_eval_rst': True,
192+
'enable_auto_toc_tree': False,
193+
}, True)
189194
app.connect('source-read', replace_relative_links)
190195
app.connect('build-finished', redirect_api_page_to_javadoc)

manual/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Common topics:
3434
* [Case sensitivity](case_sensitivity/)
3535
* [OSGi](osgi/)
3636

37-
```eval_rst
37+
```{eval-rst}
3838
.. toctree::
3939
:hidden:
4040
:glob:

manual/core/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -351,7 +351,7 @@ for (ColumnDefinitions.Definition definition : row.getColumnDefinitions()) {
351351

352352
[CASSANDRA-10145]: https://issues.apache.org/jira/browse/CASSANDRA-10145
353353

354-
```eval_rst
354+
```{eval-rst}
355355
.. toctree::
356356
:hidden:
357357
:glob:

manual/core/configuration/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -556,7 +556,7 @@ config.getDefaultProfile().getInt(MyCustomOption.AWESOMENESS_FACTOR);
556556
[HOCON]: https://github.com/typesafehub/config/blob/master/HOCON.md
557557
[API conventions]: ../../api_conventions
558558

559-
```eval_rst
559+
```{eval-rst}
560560
.. toctree::
561561
:hidden:
562562
:glob:

manual/core/metadata/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ refreshed. See the [Performance](../performance/#debouncing) page for more detai
7979
[Metadata]: https://docs.datastax.com/en/drivers/java/4.17/com/datastax/oss/driver/api/core/metadata/Metadata.html
8080
[Node]: https://docs.datastax.com/en/drivers/java/4.17/com/datastax/oss/driver/api/core/metadata/Node.html
8181

82-
```eval_rst
82+
```{eval-rst}
8383
.. toctree::
8484
:hidden:
8585
:glob:

manual/core/statements/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ can create execution profiles to capture common combinations of those options).
8383
[execute]: https://docs.datastax.com/en/drivers/java/4.17/com/datastax/oss/driver/api/core/session/Session.html#execute-com.datastax.oss.driver.api.core.cql.Statement-
8484
[executeAsync]: https://docs.datastax.com/en/drivers/java/4.17/com/datastax/oss/driver/api/core/session/Session.html#executeAsync-com.datastax.oss.driver.api.core.cql.Statement-
8585

86-
```eval_rst
86+
```{eval-rst}
8787
.. toctree::
8888
:hidden:
8989
:glob:

manual/developer/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ from lowest to highest level:
3737

3838
If you're reading this on GitHub, the `.nav` file in each directory contains a suggested order.
3939

40-
```eval_rst
40+
```{eval-rst}
4141
.. toctree::
4242
:hidden:
4343
:glob:

manual/developer/common/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ This covers utilities or concept that are shared throughout the codebase:
2727
* the [event bus](event_bus/) is used to decouple some of the internal components through
2828
asynchronous messaging.
2929

30-
```eval_rst
30+
```{eval-rst}
3131
.. toctree::
3232
:hidden:
3333
:glob:

0 commit comments

Comments
 (0)