-
Notifications
You must be signed in to change notification settings - Fork 172
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.
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
[INF/DOC] Documentation bugfix by pinning mkdocstrings to 0.18.1 #1147
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
2dc91b7
HOTFIX documentation bugfix by pinning mkdocstrings to 0.18.1
ericmjl 4fac493
Add mkdocstrings-python-legacy into env
ericmjl 68fa82f
Apply to mkdocs/environment
Zeroto521 fe1227c
Add first pass on automated test for docs build.
ericmjl 6cf4762
Commented out `mkdocs/environment.yaml` until further discussion.
ericmjl File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,23 +1,29 @@ | ||
name: pyjanitor-doc | ||
channels: | ||
- conda-forge | ||
dependencies: | ||
- python | ||
# required | ||
- pandas | ||
- pandas-flavor | ||
- multipledispatch | ||
- scipy | ||
# optional | ||
- biopython | ||
- natsort | ||
- pyspark>=3.2.0 | ||
- rdkit | ||
- tqdm | ||
- unyt | ||
- xarray | ||
- numba | ||
# doc | ||
- mkdocs | ||
- mkdocs-material | ||
- mkdocstrings-python | ||
# 14 August 2022: Temporarily commenting out. | ||
# See: https://github.com/pyjanitor-devs/pyjanitor/pull/1147#issuecomment-1214508157 | ||
# for more context on why. | ||
# name: pyjanitor-doc | ||
# channels: | ||
# - conda-forge | ||
# dependencies: | ||
# - python | ||
# # required | ||
# - pandas | ||
# - pandas-flavor | ||
# - multipledispatch | ||
# - scipy | ||
# # optional | ||
# - biopython | ||
# - natsort | ||
# - pyspark>=3.2.0 | ||
# - rdkit | ||
# - tqdm | ||
# - unyt | ||
# - xarray | ||
# - numba | ||
# # doc | ||
# - mkdocs | ||
# - mkdocs-material | ||
# # To fix #1146 | ||
# # - mkdocstrings-python | ||
# - mkdocstrings=0.18.1 | ||
# - mkdocstrings-python-legacy=0.2.2 |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
"""Tests for documentation build.""" | ||
|
||
import os | ||
|
||
|
||
def test_docs_general_functions_present(): | ||
"""Test that all docs pages build correctly. | ||
TODO: There has to be a better way to automatically check that | ||
all of the functions are present in the docs. | ||
This is an awesome thing that we could use help with in the future. | ||
""" | ||
# Build docs using mkdocs | ||
os.system("mkdocs build --clean") | ||
|
||
# We want to check that the following keywords are all present. | ||
# I put in a subsample of general functions. | ||
# This can be made much more robust. | ||
rendered_correctly = False | ||
with open("./site/api/functions/index.html", "r+") as f: | ||
for line in f.readlines(): | ||
if "add_columns" in line or "update_where" in line: | ||
rendered_correctly = True | ||
assert rendered_correctly |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Zeroto521 and @samukweku this is the automated hack I have in place to check that our docs are built correctly automatically... at least for the general functions page. We may want to do a more comprehensive thing later.