Skip to content
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: update theme 1.7 #994

Merged
merged 1 commit into from
May 14, 2024
Merged

Conversation

dgarcia360
Copy link
Contributor

Related issue scylladb/sphinx-scylladb-theme#1035

ScyllaDB Sphinx Theme 1.7 is out 🥳 Now, the docs will automatically publish when backporting changes to previous branches. This release also introduces minor style enhancements to the sidebar and homepage.

You can read more about all notable changes here.

How to test this PR

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

  2. Enter the docs folder, and run:

    make preview
    
  3. Open http://localhost: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.7.x:

image

@dgarcia360
Copy link
Contributor Author

cc/ @annastuchlik

Copy link

github-actions bot commented May 7, 2024

cargo semver-checks found no API-breaking changes in this PR! 🎉🥳
Checked commit: 9b48e01

@wprzytula wprzytula self-requested a review May 8, 2024 04:46
@wprzytula wprzytula assigned muzarski and unassigned muzarski May 8, 2024
@wprzytula wprzytula requested a review from muzarski May 8, 2024 04:46
@wprzytula
Copy link
Collaborator

Having installed poetry using dnf:
sudo dnf install poetry
and run make preview, I got an error:

Writing lock file
poetry update
Updating dependencies
Resolving dependencies... (1.3s)

No dependencies to install or update
cp -TLr source _source
python _utils/prepare_sphinx_source.py _source
Preparing sphinx source in _source
OK Done - prepared sphinx source is in _source
poetry run sphinx-autobuild -b dirhtml -d _build/doctrees  -j auto _source _build/dirhtml --port 5500
[sphinx-autobuild] > sphinx-build -b dirhtml -d _build/doctrees -j auto /home/wojciech/Repos/rust-driver-playground/docs/_source /home/wojciech/Repos/rust-driver-playground/docs/_build/dirhtml
Running Sphinx v7.2.6
/home/wojciech/.cache/pypoetry/virtualenvs/sphinx-docs-B6yYV2vv-py3.12/lib/python3.12/site-packages/sphinx_scylladb_theme/lexers/cql.py:236: SyntaxWarning: invalid escape sequence '\s'
  r"(" + "|".join(s.replace(" ", "\s+") for s in DATATYPES) + r")\b",

Extension error:
Could not import extension sphinx_multiversion (exception: No module named 'distutils')
Command exited with exit code: 2
The server will continue serving the build folder, but the contents being served are no longer in sync with the documentation sources. Please fix the cause of the error above or press Ctrl+C to stop the server.
[I 240514 07:51:51 server:335] Serving on http://127.0.0.1:5500

@Lorak-mmk
Copy link
Collaborator

Having installed poetry using dnf: sudo dnf install poetry and run make preview, I got an error:

Writing lock file
poetry update
Updating dependencies
Resolving dependencies... (1.3s)

No dependencies to install or update
cp -TLr source _source
python _utils/prepare_sphinx_source.py _source
Preparing sphinx source in _source
OK Done - prepared sphinx source is in _source
poetry run sphinx-autobuild -b dirhtml -d _build/doctrees  -j auto _source _build/dirhtml --port 5500
[sphinx-autobuild] > sphinx-build -b dirhtml -d _build/doctrees -j auto /home/wojciech/Repos/rust-driver-playground/docs/_source /home/wojciech/Repos/rust-driver-playground/docs/_build/dirhtml
Running Sphinx v7.2.6
/home/wojciech/.cache/pypoetry/virtualenvs/sphinx-docs-B6yYV2vv-py3.12/lib/python3.12/site-packages/sphinx_scylladb_theme/lexers/cql.py:236: SyntaxWarning: invalid escape sequence '\s'
  r"(" + "|".join(s.replace(" ", "\s+") for s in DATATYPES) + r")\b",

Extension error:
Could not import extension sphinx_multiversion (exception: No module named 'distutils')
Command exited with exit code: 2
The server will continue serving the build folder, but the contents being served are no longer in sync with the documentation sources. Please fix the cause of the error above or press Ctrl+C to stop the server.
[I 240514 07:51:51 server:335] Serving on http://127.0.0.1:5500

I think you need to use older python (3.10 should work). Easiest way to do so would be using pyenv.
With that being said, imo the docs should always support python installed in latest stable fedora - otherwise it adds unnecessary friction for developers.

@dgarcia360
Copy link
Contributor Author

The docs are compatible with Python 3.10. It's in our plans to make them compatible with Python 3.12 , but this is not part of the current release.

cc/ @annastuchlik

@wprzytula wprzytula requested a review from Lorak-mmk May 14, 2024 09:06
@annastuchlik
Copy link
Contributor

imo the docs should always support python installed in latest stable fedora - otherwise it adds unnecessary friction for developers.

I see your point, and we'll queue the task to add support for Python 3.12. I can't promise we'll support the Python version in the latest Fedora immediately after it is released, as it depends on the priorities in the documentation project. But we'll try to be up to date.

@wprzytula wprzytula merged commit ac2d4dc into scylladb:main May 14, 2024
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants