Open
Conversation
h-chmeruk
force-pushed
the
add-docs-folder
branch
from
c827c6c to
330aa75
Compare
ahms5
requested changes
Feb 4, 2026
template/docs/conf.py.jinja
Outdated
| {% if 'matplotlib' in dependencies -%} | ||
| 'matplotlib': ('https://matplotlib.org/stable/', None),{% endif %} | ||
| {% if 'pyfar' in dependencies -%} | ||
| 'pyfar': ('https://pyfar.readthedocs.io/en/stable/', None),{% endif %} |
Member
There was a problem hiding this comment.
i think we should add the gallery here as well:
Suggested change
| 'pyfar': ('https://pyfar.readthedocs.io/en/stable/', None),{% endif %} | |
| 'pyfar': ('https://pyfar.readthedocs.io/en/stable/', None),{% endif %} | |
| 'gallery': ('https://pyfar-gallery.readthedocs.io/en/latest/', None), |
template/docs/history.rst
Outdated
| @@ -0,0 +1 @@ | |||
| .. include:: ../HISTORY.rst No newline at end of file | |||
Member
There was a problem hiding this comment.
Suggested change
| .. include:: ../HISTORY.rst | |
| .. include:: ../HISTORY.rst | |
better to always put a new line at the end of a file, thats easier for git.
template/docs/index.rst.jinja
Outdated
| {{ project_slug }} | ||
| {% for _ in project_slug %}={% endfor %} | ||
|
|
||
| .. include:: header.rst No newline at end of file |
Member
There was a problem hiding this comment.
Suggested change
| .. include:: header.rst | |
| .. include:: header.rst | |
template/docs/contributing.rst
Outdated
| @@ -0,0 +1 @@ | |||
| .. include:: ../CONTRIBUTING.rst No newline at end of file | |||
Member
There was a problem hiding this comment.
Suggested change
| .. include:: ../CONTRIBUTING.rst | |
| .. include:: ../CONTRIBUTING.rst | |
template/docs/conf.py.jinja
Outdated
|
|
||
| # set dropdown header at pyfar appearance, so that pyfar is the first item in | ||
| # the dropdown called Packages | ||
| html_theme_options['header_links_before_dropdown'] = n_toctree_pyfar No newline at end of file |
Member
There was a problem hiding this comment.
Suggested change
| html_theme_options['header_links_before_dropdown'] = n_toctree_pyfar | |
| html_theme_options['header_links_before_dropdown'] = n_toctree_pyfar | |
| modules/{{ project_slug }} | ||
|
|
||
|
|
||
| .. _examples gallery: https://pyfar-gallery.readthedocs.io/en/latest/examples_gallery.html No newline at end of file |
Member
There was a problem hiding this comment.
Suggested change
| .. _examples gallery: https://pyfar-gallery.readthedocs.io/en/latest/examples_gallery.html | |
| .. _examples gallery: https://pyfar-gallery.readthedocs.io/en/latest/examples_gallery.html | |
template/docs/Makefile.jinja
Outdated
| # Catch-all target: route all unknown targets to Sphinx using the new | ||
| # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). | ||
| %: Makefile | ||
| @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) No newline at end of file |
Member
There was a problem hiding this comment.
Suggested change
| @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) | |
| @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) | |
template/docs/readme.rst
Outdated
| @@ -0,0 +1 @@ | |||
| .. mdinclude:: ../README.md No newline at end of file | |||
Member
There was a problem hiding this comment.
Suggested change
| .. mdinclude:: ../README.md | |
| .. mdinclude:: ../README.md | |
| .. raw:: html | ||
|
|
||
| <i class="fa-solid fa-clock-rotate-left icon-style"> | ||
| </i> No newline at end of file |
| def test_content_docs_multiple_files(default_project, file_name): | ||
| content = default_project.project_dir.joinpath(file_name).read_text() | ||
| desired = "my_project" | ||
| assert desired in content, f"{desired!r} is not in content" |
Member
There was a problem hiding this comment.
Suggested change
| assert desired in content, f"{desired!r} is not in content" | |
| assert desired in content, f"{desired!r} is not in content" | |
ahms5
added
enhancement
Member
|
maybe you can also add the .readthedocs.yml config in this pr |
Contributor
Author
|
Yeah, I will add the |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Which issue(s) are closed by this pull request?
Closes #12
Changes proposed in this pull request:
docsfolder with the most important files.