Skip to content

Commit

Permalink
Fix the doc building on RTD (#1047)
Browse files Browse the repository at this point in the history
* add deps

* mock modules

* try with full install

* actually install the package for the docs, remove mocking

* add release notes
  • Loading branch information
cdiener committed Feb 24, 2021
1 parent 06f3504 commit 567c7aa
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 32 deletions.
34 changes: 2 additions & 32 deletions documentation_builder/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,43 +14,13 @@

import sys
from os.path import dirname, join
from unittest.mock import Mock

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
SRC_PATH = join(dirname(dirname(__file__)), "src")
sys.path.insert(0, SRC_PATH)


# These modules should correspond to the importable Python packages.
MOCK_MODULES = [
"depinfo",
"numpy",
"scipy",
"scipy.optimize",
"scipy.sparse",
"scipy.io",
"scipy.stats",
"pp",
"libsbml",
"pandas",
"tabulate",
"optlang",
"optlang.interface",
"optlang.symbolics",
"optlang.symbolics.core",
"optlang.exceptions",
"future",
"future.utils",
"ruamel",
"ruamel.yaml",
"ruamel.yaml.compat",
"ruamel.yaml.main",
]
for mod_name in MOCK_MODULES:
sys.modules[mod_name] = Mock()

# -- General configuration ----------------------------------------------------

# Add any Sphinx extension module names here, as strings. They can be
Expand Down Expand Up @@ -116,8 +86,8 @@
(
"index",
"cobra.tex",
u"cobra Documentation",
u"The cobrapy core team",
"cobra Documentation",
"The cobrapy core team",
"manual",
)
]
Expand Down
4 changes: 4 additions & 0 deletions release-notes/next-release.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
# Release notes for cobrapy x.y.z

## New features

- documentation of boundary reactions (#1038)

## Fixes

## Other

- Documentation is now built again on each release

## Deprecated features

## Backwards incompatible changes

0 comments on commit 567c7aa

Please sign in to comment.