Files shared by multiple MATPOWER documentation projects.
MATPOWER documentation projects, based on Sphinx, expect to find
an mp-docs-shared
directory with the contents of this repo in their
source
directory. The main MATPOWER project already includes it as
a git subrepo
. However, building the documentation for individual
components separetely (e.g. MP-Test, MIPS, MP-Opt-Model, etc.) requires
that mp-docs-shared
be manually included in the source
directory before
building.
cd <project>/docs/sphinx/source
git clone https://github.com/MATPOWER/mp-docs-shared.git
Each project typically also relies on the use of a symlink for the CSS file.
cd <project>/docs/sphinx/source/_static/css
ln -s ../../mp-docs-shared/css/matpower.css matpower.css