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

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

Last synced: 18 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/nemani/sphinx-bug-report-example
• Owner: nemani
• Created: 2021-07-06T16:12:51.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-07-06T16:33:43.000Z (over 3 years ago)
• Last Synced: 2024-10-23T10:37:10.991Z (2 months ago)
• Language: Python
• Size: 10.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        

### Example Repo to showcase bug in sphinx autodoc

While working on some related project we noticed that autodoc does not generate valid xml output

when we use params in docstrings. This repo serves as an example for the same.

Steps to reproduce:

1. Install sphinx

2. cd docs

3. make xml

4. `xmllint --noout docs/build/xml/index.xml`

xmllint errors:

```

docs/build/xml/index.xml:19: namespace error : Namespace prefix py for class on literal_strong is not defined

ph>