Skip to content
This repository has been archived by the owner on Jan 8, 2025. It is now read-only.

feat: Be more lenient on errors if app.config.sphinxjs_lax is set #116

Closed
wants to merge 3 commits into from

Conversation

ptbrowne
Copy link
Contributor

@ptbrowne ptbrowne commented Sep 8, 2019

When integrating sphinxjs for a multi repository documentation site, I stumbled
upon several conflicts errors and Rule 'path_and_formal_params' didn't match at (#109).

For my usecase, it is more convenient to ignore those errors and fix them
on a case by case basis, so I do not mind if I ignore those doclets.

This PR adds a config attribute sphinxjs_lax that make sphinxjs doclet generation
not fail if it has errors.

Copy link
Contributor

@erikrose erikrose left a comment

Choose a reason for hiding this comment

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

Good idea for big projects. Thanks for the patch!

sphinx_js/doclets.py Outdated Show resolved Hide resolved
sphinx_js/doclets.py Outdated Show resolved Hide resolved
@ptbrowne ptbrowne force-pushed the lax branch 2 times, most recently from 878f64c to f7dcbdf Compare September 13, 2019 16:52
sphinx_js/doclets.py Outdated Show resolved Hide resolved
sphinx_js/doclets.py Outdated Show resolved Hide resolved
sphinx_js/doclets.py Outdated Show resolved Hide resolved
@ptbrowne ptbrowne force-pushed the lax branch 2 times, most recently from f687c6c to 27ce82f Compare September 15, 2019 12:47
@ptbrowne
Copy link
Contributor Author

Should be OK now, thanks for the review.

sphinx_js/doclets.py Outdated Show resolved Hide resolved
@ptbrowne ptbrowne force-pushed the lax branch 5 times, most recently from 7334423 to 7d61e95 Compare September 17, 2019 11:51
@ptbrowne ptbrowne requested a review from erikrose September 19, 2019 11:55
tests/test_parsers.py Outdated Show resolved Hide resolved
sphinx_js/doclets.py Show resolved Hide resolved
@willkg willkg added this to the 3.2 milestone Feb 23, 2022
@willkg willkg modified the milestones: 3.2.0, 3.next Dec 13, 2022
hoodmane pushed a commit to hoodmane/sphinx-js that referenced this pull request May 2, 2024
hoodmane added a commit to hoodmane/sphinx-js that referenced this pull request May 2, 2024
…) (mozilla#116)

The parameter `jsdoc_config_path` was pointing to `typedoc --tsconfig` which is
the compiler options, it should be the typedoc configuration `typedoc --options`

I added a parameter `jsdoc_tsconfig_path` to be able to specify the `typedoc
--tsconfig` if needed

I updated unit test and doc.

It is a breaking change so we might want to bump version or add migration note.
Available to update the PR as needed.
@willkg
Copy link
Member

willkg commented Dec 31, 2024

I'm sorry, but we're shutting down this project. You could look at making these changes to sphinx-js-fork if they're not made already. Thank you!

@willkg willkg closed this Dec 31, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants