Skip to content

docs: update theme 1.1#136

Merged
fruch merged 3 commits intoscylladb:masterfrom
dgarcia360:docs-update-theme-1-1
Mar 8, 2022
Merged

docs: update theme 1.1#136
fruch merged 3 commits intoscylladb:masterfrom
dgarcia360:docs-update-theme-1-1

Conversation

@dgarcia360
Copy link
Copy Markdown
Collaborator

@dgarcia360 dgarcia360 commented Feb 9, 2022

Related issue scylladb/sphinx-scylladb-theme#310

ScyllaDB Sphinx Theme 1.1 is now released 🥳

We’ve made a number of updates to update all our dependencies to the latest version and introduced new directives you can use to write great docs.

You can read more about all notable changes here.

⚠️Breaking changes

Before, the theme installed poetry 1.1.x as a dependency to manage Python dependencies. However, poetry 1.2.x changed the installation method. Therefore, we've decided to #307 Make poetry a prerequisite so that you can decide to install the poetry version you prefer.

To preview the docs locally, you should uninstall the previous version of poetry. Then, install the latest version:

  1. Uninstall Poetry 1.1.x.
curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | POETRY_UNINSTALL=1 python -
  1. Install Poetry 1.2.x. For detailed instructions, see Poetry installation.

How to test this PR

  1. Clone this PR. For more information, see Cloning pull requests locally.

  2. Uninstall poetry 1.1 and install poetry 1.2. For more information, see Breaking changes notice above.

  3. Enter the docs folder, and run:

make preview
  1. Open http://127.0.0.1:5500/ with your favorite browser. The doc should render without errors, and the version should be Sphinx Theme version (see the footer) must be 1.1.x:

image

@dgarcia360 dgarcia360 mentioned this pull request Feb 9, 2022
Closed
15 tasks
@dgarcia360 dgarcia360 marked this pull request as draft February 9, 2022 11:14
@dgarcia360 dgarcia360 marked this pull request as ready for review February 9, 2022 11:47
@dgarcia360 dgarcia360 requested review from fruch and tzach February 16, 2022 11:26
@fruch
Copy link
Copy Markdown

fruch commented Feb 23, 2022

@dgarcia360 the doc build is failing, but every time I come back to it, the logs are gone.

@dgarcia360
Copy link
Copy Markdown
Collaborator Author

dgarcia360 commented Feb 23, 2022

I'm getting the following warnings:

/home/runner/work/python-driver/python-driver/cassandra/datastax/graph/query.py:docstring of cassandra.datastax.graph.query.GraphProtocol:1: WARNING: duplicate object description of cassandra.datastax.graph.query.GraphProtocol, other instance in api/cassandra/datastax/graph/index, use :noindex: for one of them
/home/runner/work/python-driver/python-driver/cassandra/datastax/graph/query.py:docstring of cassandra.datastax.graph.query.GraphOptions:1: WARNING: duplicate object description of cassandra.datastax.graph.query.GraphOptions, other instance in api/cassandra/datastax/graph/index, use :noindex: for one of them
/home/runner/work/python-driver/python-driver/cassandra/datastax/graph/query.py:docstring of cassandra.datastax.graph.query.SimpleGraphStatement:1: WARNING: duplicate object description of cassandra.datastax.graph.query.SimpleGraphStatement, other instance in api/cassandra/datastax/graph/index, use :noindex: for one of them
/home/runner/work/python-driver/python-driver/cassandra/datastax/graph/query.py:docstring of cassandra.datastax.graph.query.Result:1: WARNING: duplicate object description of cassandra.datastax.graph.query.Result, other instance in api/cassandra/datastax/graph/index, use :noindex: for one of them
/home/runner/work/python-driver/python-driver/cassandra/datastax/graph/types.py:docstring of cassandra.datastax.graph.types.Vertex:1: WARNING: duplicate object description of cassandra.datastax.graph.types.Vertex, other instance in api/cassandra/datastax/graph/index, use :noindex: for one of them
/home/runner/work/python-driver/python-driver/cassandra/datastax/graph/types.py:docstring of cassandra.datastax.graph.types.VertexProperty:1: WARNING: duplicate object description of cassandra.datastax.graph.types.VertexProperty, other instance in api/cassandra/datastax/graph/index, use :noindex: for one of them
/home/runner/work/python-driver/python-driver/cassandra/datastax/graph/types.py:docstring of cassandra.datastax.graph.types.Edge:1: WARNING: duplicate object description of cassandra.datastax.graph.types.Edge, other instance in api/cassandra/datastax/graph/index, use :noindex: for one of them
/home/runner/work/python-driver/python-driver/cassandra/datastax/graph/types.py:docstring of cassandra.datastax.graph.types.Path:1: WARNING: duplicate object description of cassandra.datastax.graph.types.Path, other instance in api/cassandra/datastax/graph/index, use :noindex: for one of them
/home/runner/work/python-driver/python-driver/cassandra/datastax/graph/graphson.py:docstring of cassandra.datastax.graph.graphson.GraphSON1Serializer:1: WARNING: duplicate object description of cassandra.datastax.graph.graphson.GraphSON1Serializer, other instance in api/cassandra/datastax/graph/index, use :noindex: for one of them
/home/runner/work/python-driver/python-driver/cassandra/datastax/graph/graphson.py:docstring of cassandra.datastax.graph.graphson.GraphSON1Deserializer:1: WARNING: duplicate object description of cassandra.datastax.graph.graphson.GraphSON1Deserializer, other instance in api/cassandra/datastax/graph/index, use :noindex: for one of them
/home/runner/work/python-driver/python-driver/cassandra/datastax/graph/graphson.py:docstring of cassandra.datastax.graph.graphson.GraphSON2Reader:1: WARNING: duplicate object description of cassandra.datastax.graph.graphson.GraphSON2Reader, other instance in api/cassandra/datastax/graph/index, use :noindex: for one of them

I'll update the pull-request with the fix.

@tzach
Copy link
Copy Markdown

tzach commented Feb 23, 2022

The graph integration part is not relevant and can be commented our or removed

fruch
fruch approved these changes Mar 8, 2022
View reviewed changes
Copy link
Copy Markdown

@fruch fruch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@fruch fruch force-pushed the docs-update-theme-1-1 branch from 4369841 to 364c290 Compare March 8, 2022 10:04
@fruch fruch merged commit 6d6e19e into scylladb:master Mar 8, 2022
@dgarcia360 dgarcia360 deleted the docs-update-theme-1-1 branch March 8, 2022 11:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@fruch fruch fruch approved these changes

@tzach tzach Awaiting requested review from tzach

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@dgarcia360 @fruch @tzach