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

Fix #1522: fix 'str' object has no attribute 'attributes' #1528

Merged
merged 4 commits into from
Oct 24, 2023
Merged

Fix #1522: fix 'str' object has no attribute 'attributes' #1528

merged 4 commits into from
Oct 24, 2023

Conversation

leplatrem
Copy link
Contributor

Fix #1522

@leplatrem leplatrem requested a review from a team as a code owner September 28, 2023 11:19
@leplatrem leplatrem mentioned this pull request Sep 28, 2023
Closed
@agjohnson
Copy link
Collaborator

Thanks for the fix here @leplatrem !

This was recently changed, in #1519, though it wasn't clear if there was going to be any side effects from the change. I guess there are side effects, which isn't too surprising.

This is reverting to what we had before, so should definitely be safe. But I will first try to understand what is happening in #1522, or why the css_tag fails here. It was my understanding the css_tag call would be safer, but I'm guessing it comes down to the Sphinx configuration.

I'll want to aim to merge this in, reverting that change, before next week. I'm planning on a 2.0 final release on Monday or Tues.

@agjohnson agjohnson modified the milestones: 2.0, 2.1 Sep 28, 2023
@leplatrem
Copy link
Contributor Author

Excellent, thank you! 💚

agjohnson
agjohnson approved these changes Sep 29, 2023
View reviewed changes
Copy link
Collaborator

@agjohnson agjohnson left a comment

Choose a reason for hiding this comment

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

This is revert to the old logic, it should be okay. If I don't come up with another fix or reason to keep the current logic, I'll look to merge this early next week for the 2.0 release. We can revisit the reverted change again in another release if we need.

mitya57
mitya57 reviewed Sep 30, 2023
View reviewed changes
sphinx_rtd_theme/layout.html Outdated Show resolved Hide resolved
sphinx_rtd_theme/layout.html Outdated Show resolved Hide resolved
@mitya57 mitya57 mentioned this pull request Oct 10, 2023
Closed
@humitos
Revert "Fix readthedocs#1522: fix attribute error if css is str"
82ee56f 
This reverts commit b22a77f.
@humitos
Use css_tag only for standard CSS files from Sphinx
c4edd8b 
... and keep using the custom `link` HTML tag for CSS files included via the
HTML theme option `extra_css_files`.
@humitos
Copy link
Member

humitos commented Oct 23, 2023

I updated this PR to take into consideration the review comments from @mitya57. It should work for all the Sphinx versions we support now. I'd be happy to merge this PR and release a new rc version to PyPI so people can continue testing it.

@mitya57
Copy link
Contributor

mitya57 commented Oct 23, 2023

This looks good to me now. 👍

agjohnson
agjohnson approved these changes Oct 23, 2023
View reviewed changes
Copy link
Collaborator

@agjohnson agjohnson left a comment

Choose a reason for hiding this comment

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

This fix looks good to me, I'll get an RC prepared this afternoon so we can test the fix further.

I pushed up a change just standardizing the variable names, will wait on that.

humitos
humitos approved these changes Oct 23, 2023
View reviewed changes
Copy link
Member

@humitos humitos left a comment

Choose a reason for hiding this comment

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

Looks good to me.

@agjohnson agjohnson merged commit 32310a8 into readthedocs:master Oct 24, 2023
@agjohnson
Copy link
Collaborator

2.0.0rc3 is now out with this fix. Thanks everyone!

@mitya57 mitya57 mentioned this pull request Oct 28, 2023
Merged
khancyr pushed a commit to ArduPilot/sphinx_rtd_theme that referenced this pull request Jul 15, 2024
@humitos @khancyr
update to sphinx theme master 2.0.0
f2bbe7d 
* 2.0 milestone: drop supported versions

The new policy is:

- Python >=3.6
- Sphinx >= 5
- HTML4 and HTML5 writer
- docutils >= 0.14, < 0.19

* Update roadmap after discussion

By the beginning of 2024 we should support newer Sphinx versions and HTML5 only.

* Remove Python 2.7 from CircleCI

* Run only supported versions on Python 3.11

* Update with feedback from review

* Update documentation to match our support

* Add Sphinx 6.2 that was missing

* Update tox/circleci to work

* Revert tox command

* Drop support for HTML4 and keep `-qa` testing

- drop support for HTML4 on 2.0
- keep `-qa` TOX environment to be able to compare feature branches
- emit `logger.errors` on Python 2 and html_writer4=True
- require Sphinx >= 5.0
- remove logic for old Sphinx versions

* Update Tox and CircleCI

* Update contributing page to match our plans

---------

Co-authored-by: Anthony Johnson <aj@ohess.org>

Release 2.0.0rc1 (readthedocs#1510)

* Release 2.0.0rc1

* Update npm lock file

Bump to next release 2.0.0rc2 (readthedocs#1511)

Docs: Remove "git install" method from instructions (readthedocs#1375)

* Remove instructions "encouraging" to install directly from git

* Update changelog: Add reminder that people should not install directly from git

* Update docs/changelog.rst

---------

Co-authored-by: Manuel Kaufmann <humitos@gmail.com>

Visual test with Firefox and tox (readthedocs#1513)

* Visual test with Firefox and tox

Allows developer to run

```
tox -e py310-sphinx72-firefox
```

This will run the tests and open a Firefox after building the demo site
showing the `demo/demo.html` page on it.

Then, you can also run:

```
tox -e py310-sphinx61-firefox
```

and compare the visual differences.

Idea copied from readthedocs#1388
Closes readthedocs#1388

* Default value for `DISPLAY` and `--new-tab`

* Simplify the idea :)

Remove Python2 leftovers (readthedocs#1514)

Docs: update Read the Docs config (readthedocs#1518)

Use the latest config file style.

Set data-content_root for Sphinx ≥ 7.2 (readthedocs#1507)

This attribute is now required by searchtools.js:
https://github.com/sphinx-doc/sphinx/blob/v7.2.2/sphinx/themes/basic/static/searchtools.js#L65

When it's not set, loading search results via AJAX will be broken
because the JS code will attempt to load paths like /undefinedfoo.html.

Co-authored-by: Manuel Kaufmann <humitos@gmail.com>

Use `css_tag` helper to inject CSS files (readthedocs#1519)

* Use `css_tag` helper to inject CSS files

* Typo

Add support for `docutils==0.20.x` (readthedocs#1517)

Closes readthedocs#1516

Release 2.0rc2 (readthedocs#1520)

Version bump for 2.0rc3 development (readthedocs#1521)

Next development version is 2.0rc3 for now, but more likely 2.1rc1

Fix readthedocs#1522: fix `'str' object has no attribute 'attributes'` (readthedocs#1528)

* Fix readthedocs#1522: fix attribute error if css is str

* Revert "Fix readthedocs#1522: fix attribute error if css is str"

This reverts commit b22a77f.

* Use `css_tag` only for standard CSS files from Sphinx

... and keep using the custom `link` HTML tag for CSS files included via the
HTML theme option `extra_css_files`.

* Normalize template variables

---------

Co-authored-by: Manuel Kaufmann <humitos@gmail.com>
Co-authored-by: Anthony Johnson <aj@ohess.org>

Release 2.0.0rc3 (readthedocs#1535)

Increment for next potential release (readthedocs#1536)

Fix AttributeError when one of `css_files` is a string (readthedocs#1537)

Fix AttributeError when one of css_files is a string

Release 2.0.0rc4 (readthedocs#1538)

Bump for next potential release, 2.0.0rc5 (readthedocs#1539)

Release 2.0 final (readthedocs#1544)
@khancyr khancyr mentioned this pull request Jul 15, 2024
Merged
khancyr pushed a commit to ArduPilot/sphinx_rtd_theme that referenced this pull request Sep 1, 2024
@humitos @khancyr
update to sphinx theme master 2.0.0
204465a 
* 2.0 milestone: drop supported versions

The new policy is:

- Python >=3.6
- Sphinx >= 5
- HTML4 and HTML5 writer
- docutils >= 0.14, < 0.19

* Update roadmap after discussion

By the beginning of 2024 we should support newer Sphinx versions and HTML5 only.

* Remove Python 2.7 from CircleCI

* Run only supported versions on Python 3.11

* Update with feedback from review

* Update documentation to match our support

* Add Sphinx 6.2 that was missing

* Update tox/circleci to work

* Revert tox command

* Drop support for HTML4 and keep `-qa` testing

- drop support for HTML4 on 2.0
- keep `-qa` TOX environment to be able to compare feature branches
- emit `logger.errors` on Python 2 and html_writer4=True
- require Sphinx >= 5.0
- remove logic for old Sphinx versions

* Update Tox and CircleCI

* Update contributing page to match our plans

---------

Co-authored-by: Anthony Johnson <aj@ohess.org>

Release 2.0.0rc1 (readthedocs#1510)

* Release 2.0.0rc1

* Update npm lock file

Bump to next release 2.0.0rc2 (readthedocs#1511)

Docs: Remove "git install" method from instructions (readthedocs#1375)

* Remove instructions "encouraging" to install directly from git

* Update changelog: Add reminder that people should not install directly from git

* Update docs/changelog.rst

---------

Co-authored-by: Manuel Kaufmann <humitos@gmail.com>

Visual test with Firefox and tox (readthedocs#1513)

* Visual test with Firefox and tox

Allows developer to run

```
tox -e py310-sphinx72-firefox
```

This will run the tests and open a Firefox after building the demo site
showing the `demo/demo.html` page on it.

Then, you can also run:

```
tox -e py310-sphinx61-firefox
```

and compare the visual differences.

Idea copied from readthedocs#1388
Closes readthedocs#1388

* Default value for `DISPLAY` and `--new-tab`

* Simplify the idea :)

Remove Python2 leftovers (readthedocs#1514)

Docs: update Read the Docs config (readthedocs#1518)

Use the latest config file style.

Set data-content_root for Sphinx ≥ 7.2 (readthedocs#1507)

This attribute is now required by searchtools.js:
https://github.com/sphinx-doc/sphinx/blob/v7.2.2/sphinx/themes/basic/static/searchtools.js#L65

When it's not set, loading search results via AJAX will be broken
because the JS code will attempt to load paths like /undefinedfoo.html.

Co-authored-by: Manuel Kaufmann <humitos@gmail.com>

Use `css_tag` helper to inject CSS files (readthedocs#1519)

* Use `css_tag` helper to inject CSS files

* Typo

Add support for `docutils==0.20.x` (readthedocs#1517)

Closes readthedocs#1516

Release 2.0rc2 (readthedocs#1520)

Version bump for 2.0rc3 development (readthedocs#1521)

Next development version is 2.0rc3 for now, but more likely 2.1rc1

Fix readthedocs#1522: fix `'str' object has no attribute 'attributes'` (readthedocs#1528)

* Fix readthedocs#1522: fix attribute error if css is str

* Revert "Fix readthedocs#1522: fix attribute error if css is str"

This reverts commit b22a77f.

* Use `css_tag` only for standard CSS files from Sphinx

... and keep using the custom `link` HTML tag for CSS files included via the
HTML theme option `extra_css_files`.

* Normalize template variables

---------

Co-authored-by: Manuel Kaufmann <humitos@gmail.com>
Co-authored-by: Anthony Johnson <aj@ohess.org>

Release 2.0.0rc3 (readthedocs#1535)

Increment for next potential release (readthedocs#1536)

Fix AttributeError when one of `css_files` is a string (readthedocs#1537)

Fix AttributeError when one of css_files is a string

Release 2.0.0rc4 (readthedocs#1538)

Bump for next potential release, 2.0.0rc5 (readthedocs#1539)

Release 2.0 final (readthedocs#1544)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mitya57 mitya57 mitya57 left review comments

@agjohnson agjohnson agjohnson approved these changes

@humitos humitos humitos approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
2.0
Development

Successfully merging this pull request may close these issues.

Error with 2.0.0rc2: AttributeError("'str' object has no attribute 'attributes'")
4 participants
@leplatrem @agjohnson @humitos @mitya57