Skip to content

Autodoc generates invalid xml #9413

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
Closed
nemani opened this issue Jul 6, 2021 · 3 comments
Closed

Autodoc generates invalid xml #9413

nemani opened this issue Jul 6, 2021 · 3 comments
Labels
builder type:bug
Milestone
4.4.0

Comments

@nemani
Copy link

nemani commented Jul 6, 2021 •
edited
Loading

Describe the bug

When using autodoc along with python function signatures containing "params" with XML builder the generated xml is not valid.

We think the issue is due to the following commit: 30c594f

How to Reproduce

  1. git clone https://github.com/nemani/sphinx-bug-report-example
  2. Install sphinx
  3. cd docs
  4. make xml
  5. xmllint --noout docs/build/xml/index.xml

Expected behavior

The generated XML should be valid and xml lint should not have any errorss

Your project

https://github.com/nemani/sphinx-bug-report-example

Screenshots

No response

OS

mac

Python version

3.7.5

Sphinx version

4.0.3

Sphinx extensions

sphinx.ext.autodoc

Extra tools

Additional context
@nemani nemani added the type:bug label Jul 6, 2021
@nemani
Copy link
Author

nemani commented Jul 7, 2021 •
edited
Loading

This is being a huge blocker for me.
@tk0miya any suggested workarounds for this?

nemani pushed a commit to nemani/sphinx that referenced this issue Jul 7, 2021
sphinx-doc#9413 Declare py namespace on document root to generate val…

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode
f1fbb98 
…id xml
@nemani nemani mentioned this issue Jul 7, 2021
Closed
@nemani
Copy link
Author

nemani commented Jul 7, 2021

I have a suggested fix up as a PR.

@tk0miya tk0miya added the builder label Jul 8, 2021
@tk0miya tk0miya added this to the 4.2.0 milestone Jul 8, 2021
@ghost
Copy link

ghost commented Aug 8, 2021 •
edited by ghost
Loading

The moment I thought to have finally found a solution to work around autodoc bugs... this appears to be also broken at the baseline. Lol. Please, please fix it... the amount of work I've invested already in trying to generate documentation and trying to work around broken parts is getting into the area where it would've been just easier to do it all from scratch.

@tk0miya tk0miya modified the milestones: 4.2.0, 4.3.0 Sep 12, 2021
@tk0miya tk0miya modified the milestones: 4.3.0, 4.4.0 Nov 8, 2021
tk0miya added a commit to tk0miya/sphinx that referenced this issue Jan 15, 2022
@tk0miya
Fix sphinx-doc#9413: xml: Invalid XML was generated when cross refere…
46f6d94 
…ncing python objects
@tk0miya tk0miya mentioned this issue Jan 15, 2022
Merged
tk0miya added a commit that referenced this issue Jan 15, 2022
@tk0miya
Merge pull request #10100 from tk0miya/9413_xml_namespace
453e0c7 
Fix #9413: xml: Invalid XML was generated when cross referencing python objects
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 15, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
builder type:bug
Projects
None yet
Milestone
4.4.0
Development

No branches or pull requests
2 participants
@tk0miya @nemani