Skip to content

Commit a69568b

Browse files
committed
Update README and LICENSE.
1 parent 348bb29 commit a69568b

File tree

2 files changed

+28
-3
lines changed

2 files changed

+28
-3
lines changed

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
BSD 3-Clause License
22

3-
Copyright (c) 2022, MATPOWER Development
3+
Copyright (c) 2022, Ray D. Zimmerman
44
All rights reserved.
55

66
Redistribution and use in source and binary forms, with or without

README.md

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,27 @@
1-
# mp-docs-shared
2-
A sub repo shared by multiple MATPOWER documentation projects.
1+
mp-docs-shared
2+
==============
3+
4+
### Files shared by multiple [MATPOWER][1] documentation projects.
5+
6+
[MATPOWER][1] documentation projects, based on [Sphinx][2], expect to find
7+
an `mp-docs-shared` directory with the contents of this repo in their
8+
`source` directory. The main [MATPOWER][1] project already includes it as
9+
a [`git subrepo`][3]. However, building the documentation for individual
10+
components separetely (e.g. MP-Test, MIPS, MP-Opt-Model, etc.) requires
11+
that `mp-docs-shared` be manually included in the `source` directory before
12+
building.
13+
```
14+
cd <project>/docs/sphinx/source
15+
git clone https://github.com/MATPOWER/mp-docs-shared.git
16+
```
17+
18+
Each project typically also relies on the use of a symlink for the CSS file.
19+
```
20+
cd <project>/docs/sphinx/source/_static/css
21+
ln -s ../../mp-docs-shared/css/matpower.css matpower.css
22+
```
23+
24+
25+
[1]: https://matpower.org
26+
[2]: https://www.sphinx-doc.org/
27+
[3]: https://github.com/ingydotnet/git-subrepo

0 commit comments

Comments
 (0)