Skip to content

Fix docs #725

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions .github/workflows/doc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,15 @@ jobs:
pip3 install sphinx
pip3 install sphinx-rtd-theme
git checkout --orphan gh-pages
rm -rf *
shopt -s extglob
rm -rf !("pyproject.toml") # we need this file for correct version extraction
git fetch
git reset
git clean -fdx
git clean -fdx -n --exclude="!pyproject.toml"
git checkout ${{ github.sha }} -- batchflow docs
cd docs
make html
rm ../pyproject.toml

- name: Push docs
if: github.event_name == 'pull_request'
Expand Down
2 changes: 1 addition & 1 deletion batchflow/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
from .notifier import Notifier, notifier
from .named_expr import NamedExpression, B, L, C, F, V, M, D, R, W, P, PP, I, eval_expr
from .dsindex import DatasetIndex, FilesIndex
from .decorators import action, any_action_failed, mjit, deprecated, apply_parallel
from .decorators import action, any_action_failed, mjit, deprecated, apply_parallel, parallel, inbatch_parallel
from .exceptions import SkipBatchException, EmptyBatchSequence, StopPipeline
from .run_notebook import run_notebook
from .sampler import Sampler, ConstantSampler, NumpySampler, HistoSampler, ScipySampler
Expand Down
8 changes: 4 additions & 4 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -91,11 +91,11 @@ def setup(app):

intersphinx_mapping = {
'python': ('https://docs.python.org/3', None),
'numpy': ('http://docs.scipy.org/doc/numpy/', None),
'scipy': ('http://docs.scipy.org/doc/scipy/reference/', None),
'pandas': ('http://pandas-docs.github.io/pandas-docs-travis/', None),
'numpy': ('https://numpy.org/doc/stable/', None),
'scipy': ('https://docs.scipy.org/doc/scipy/', None),
'pandas': ('http://pandas.pydata.org/pandas-docs/stable/', None),
}
autodoc_mock_imports = ['torch']
autodoc_mock_imports = ['torch', 'torchvision']
viewcode_follow_imported_members = True

# Output file base name for HTML help builder.
Expand Down