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.1 #1673

Merged
merged 1 commit into from
Feb 11, 2022
Merged

docs: update theme 1.1 #1673

merged 1 commit into from
Feb 11, 2022

Conversation

dgarcia360
Copy link
Contributor

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

docs: update theme 1.1

Clean Makefile
@amnonh
Copy link
Collaborator

amnonh commented Feb 10, 2022

@tzach I'm putting you as a reviwer

@amnonh
Copy link
Collaborator

amnonh commented Feb 11, 2022

@dgarcia360 After merging, do I need to backport or do something else?

@dgarcia360
Copy link
Contributor Author

Nothing, it's not necessary to backport to other branches

@amnonh amnonh merged commit 1555bb2 into scylladb:master Feb 11, 2022
@amnonh
Copy link
Collaborator

amnonh commented Feb 11, 2022

I've try to use it localy and got:

$ make preview
/home/amnon/.local/bin/poetry install
Installing dependencies from lock file
Warning: The lock file is not up to date with the latest changes in pyproject.toml. You may be getting outdated dependencies. Run update to update them.

  SolveFailure

  Because scylla-monitoring-docs depends on Sphinx (^4.3.2) which doesn't match any versions, version solving failed.

  at ~/.local/share/pypoetry/venv/lib64/python3.9/site-packages/poetry/mixology/version_solver.py:315 in _resolve_conflict
      311│             )
      312│             self._log(f'{bang} which is caused by "{most_recent_satisfier.cause}"')
      313│             self._log(f"{bang} thus: {incompatibility}")
      314│ 
    → 315│         raise SolveFailure(incompatibility)
      316│ 
      317│     def _choose_package_version(self) -> Optional[str]:
      318│         """
      319│         Tries to select a version of a required package.

The following error occurred when trying to handle this error:


  SolverProblemError

  Because scylla-monitoring-docs depends on Sphinx (^4.3.2) which doesn't match any versions, version solving failed.

  at ~/.local/share/pypoetry/venv/lib64/python3.9/site-packages/poetry/puzzle/solver.py:146 in _solve
      142│             packages = result.packages
      143│         except OverrideNeeded as e:
      144│             return self.solve_in_compatibility_mode(e.overrides, use_latest=use_latest)
      145│         except SolveFailure as e:
    → 146│             raise SolverProblemError(e)
      147│ 
      148│         # NOTE passing explicit empty array for seen to reset between invocations during update + install cycle
      149│         results = dict(
      150│             depth_first_search(
make: *** [Makefile:27: setup] Error 1

@dgarcia360
Copy link
Contributor Author

@amnonh Please try to delete the file docs/poetry.lock and run the command again.

@amnonh
Copy link
Collaborator

amnonh commented Feb 11, 2022

thanks, it solved it

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.

None yet

3 participants