Skip to content

Commit

Permalink
Merge pull request #85 from yarikoptic/bf-docs
Browse files Browse the repository at this point in the history
Fixup intersphinx_mapping for Python and add RTD config file; Fix typo along the way
  • Loading branch information
yarikoptic authored Mar 19, 2024
2 parents 2666247 + 5c2e41c commit b4b163c
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 2 deletions.
2 changes: 1 addition & 1 deletion datalad_deprecated/metadata/metadata.py
Original file line number Diff line number Diff line change
Expand Up @@ -670,7 +670,7 @@ def _get_metadata(ds, types, global_meta=None, content_meta=None, paths=None):
# important: we want to have a stable order regarding
# the unique values (a list). we cannot guarantee the
# same order of discovery, hence even when not using a
# set above we would still need sorting. the callenge
# set above we would still need sorting. the challenge
# is that any value can be an arbitrarily complex nested
# beast
# we also want to have each unique value set always come
Expand Down
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@
todo_include_todos = True

# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'https://docs.python.org/': None}
intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}

# -- Options for HTML output ----------------------------------------------

Expand Down
26 changes: 26 additions & 0 deletions readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the version of Python and other tools you might need
build:
os: ubuntu-20.04
tools:
python: "3.9"

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/source/conf.py


formats: all

# Optionally declare the Python requirements required to build your docs
python:
install:
- path: .
method: pip
- requirements: requirements-devel.txt

0 comments on commit b4b163c

Please sign in to comment.