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

Docs update to reflect sphinx progress on #34 #142

Merged
merged 2 commits into from
Dec 21, 2023
Merged

Docs update to reflect sphinx progress on #34 #142

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9fceb5e
Update README to reflect sphinx bugfix (#34)
linusmarco Nov 10, 2023
c6ae67c
Fix link to EBP docs contributing page
linusmarco Nov 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Thank you for being interested in contributing to the `sphinx-autobuild`! You
are awesome. :sparkles:

See the [EBP Contributing Guide](https://executablebooks.org/en/latest/contributing.html) for general details,
See the [EBP Contributing Guide](https://executablebooks.org/en/latest/contribute/) for general details,
then this page contains information to help you get started with development on this project.

## Feature Suggestions
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ sphinx-autobuild --port=0 --open-browser magikarp/docs magickarp/docs/_build/htm

## Relevant Sphinx Bugs

Sphinx does not [detect changes in non-document files in incremental mode](https://github.com/GaretJax/sphinx-autobuild/issues/34), like theme files, static files and source code used with autodoc.
Sphinx does not [detect changes in non-document, non-code files in incremental mode](https://github.com/GaretJax/sphinx-autobuild/issues/34), like theme files and static files.

At the time of writing, the only known workaround is to instruct Sphinx to rebuild the relevant pages. This can be done by disabling incremental mode (with `-a`) or passing relevant `filenames` in addition to source and output directory in the CLI.

Expand Down