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.

Sign up for GitHub

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

Jump to bottom

Release 1.1 #310

Closed
15 tasks done
dgarcia360 opened this issue Jan 12, 2022 · 2 comments
Closed
15 tasks done

Release 1.1 #310

dgarcia360 opened this issue Jan 12, 2022 · 2 comments
Assignees
@dgarcia360
Labels
enhancement New feature or request
Milestone
1.1

Comments

@dgarcia360
Copy link
Collaborator

dgarcia360 commented Jan 12, 2022 •
edited

Checklist:
@dgarcia360 dgarcia360 added the enhancement New feature or request label Jan 12, 2022
@dgarcia360 dgarcia360 added this to the 1.1 milestone Jan 12, 2022
@dgarcia360 dgarcia360 self-assigned this Jan 12, 2022
@dgarcia360 dgarcia360 mentioned this issue Jan 26, 2022
Merged
This was referenced Feb 9, 2022
Merged
Merged
Merged
Merged
Merged
Closed
avikivity added a commit to scylladb/scylladb that referenced this issue Feb 10, 2022
@avikivity
Merge 'docs: update theme 1.1' from David Garcia
2e2b542 
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](https://sphinx-theme.scylladb.com/master/upgrade/CHANGELOG.html#february-2022).

Before,  the theme installed [poetry 1.1.x](https://python-poetry.org/) 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](scylladb/sphinx-scylladb-theme#307) 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 -
```

2. Install Poetry 1.2.x. For detailed instructions, see [Poetry installation](https://python-poetry.org/docs/master/#installation).

1. Clone this PR. For more information, see [Cloning pull requests locally](https://docs.github.com/en/github/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-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
````

4. 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](https://user-images.githubusercontent.com/9107969/152107446-52b167d8-c607-4431-a7a4-92579153d024.png)

Closes #10054

* github.com:scylladb/scylla:
  Add missing lexer
  docs: update theme 1.1
@tnozicka
Copy link
Member

the 1.1 upgrade guide has a wrong dependency. It claims we should use pygments = "2.2.0" while dependabot screams at us that we need at least 2.7.4 scylladb/scylla-operator#943

This was referenced Feb 11, 2022
Merged
Merged
@dgarcia360
Copy link
Collaborator Author

Good catch, thanks! Fixed in #359

@dgarcia360 dgarcia360 mentioned this issue Apr 1, 2022
Closed
@dgarcia360 dgarcia360 mentioned this issue May 17, 2022
Closed
@dgarcia360 dgarcia360 mentioned this issue Apr 4, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dgarcia360 dgarcia360

Labels
enhancement New feature or request
Projects
None yet
Milestone
1.1
Development

No branches or pull requests
2 participants
@dgarcia360 @tnozicka