Skip to content

Commit 488d91e

Browse files
committed
Move documentation to Sphinx
1 parent afd5f20 commit 488d91e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+1292
-1209
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,4 @@ Thumbs.db
66
auto/
77
/release/
88
/venv/
9+
/docs/_build/

README.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,30 @@
1-
# PythonMcu
1+
# Python MCU
22

3-
Mackie Host Controller written in Python
3+
A Mackie Host Controller written in Python.
44

55
## Documentation
66

77
For documentation and further information, please see the directory
8-
[doc][], especially the [manual][].
8+
[docs](docs), especially the [manual](docs/manual.rst).
99

1010
## Code of conduct
1111

12-
Please read the [code of conduct][COC] before asking for help, filing
13-
bug reports or contributing to this project. Thanks!
12+
Please read the [code of conduct](CODE_OF_CONDUCT.md) before asking for help, filing bug reports or contributing to this
13+
project. Thanks!
1414

1515
## License
1616

17-
Copyright (c) 2011 [Martin Zuther][]
18-
Copyright (c) 2021 Raphaël Doursenaud
17+
![GPLv3 or later](docs/include/images/gplv3-or-later.png)
1918

20-
This program is free software: you can redistribute it and/or modify
21-
it under the terms of the GNU General Public License as published by
22-
the Free Software Foundation, either version 3 of the License, or
19+
Copyright (c) 2011 [Martin Zuther](https://www.mzuther.de)
20+
Copyright (c) 2021 [Raphaël Doursenaud](https://raphael.doursenaud.fr)
21+
22+
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public
23+
License as published by the Free Software Foundation, either version 3 of the License, or
2324
(at your option) any later version.
2425

25-
This program is distributed in the hope that it will be useful,
26-
but WITHOUT ANY WARRANTY; without even the implied warranty of
27-
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
28-
GNU General Public License for more details.
26+
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
27+
warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
2928

3029
You should have received a copy of the GNU General Public License
3130
along with this program. If not, see <http://www.gnu.org/licenses/>.

TODO.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
- [x] [mzuther] implement basic functionality
22
- [x] [rdoursenaud] port to python 3 and pyside 2
33
- [x] [rdoursenaud] cleanup code and make it PEP008 compliant
4+
- [x] [rdoursenaud] port latex documentation to Sphinx
45
- [ ] [rdoursenaud] write pytest unit tests only looking at the protocol docs
56
- [ ] [rdoursenaud] properly handle invalid config file
67
- [ ] [rdoursenaud] disallow start if MIDI ports are not set in the GUI
@@ -9,6 +10,9 @@
910
- [ ] [rdoursenaud] create virtualports using rtmidi for supported platforms (And remove MIDI Yoke references)
1011
- [ ] [rdoursenaud] create windows virtualports using pytemidi (Requires Loop Midi to be installed)
1112
- [ ] [rdoursenaud] explore if using mido could be beneficial
13+
- [ ] [rdoursenaud] add a nice icon
14+
- [ ] [rdoursenaud] reduce and restore from systray using QSystemTrayIcon or pystray
1215
- [ ] [rdoursenaud] create Microsoft Windows binary using pyinstaller?
13-
- [ ] [rdoursenaud] update documentation (and move to rtd?)
16+
- [x] [rdoursenaud] update documentation
17+
- [ ] [rdoursenaud] publish documentation to readthedocs.org
1418
- [ ] [rdoursenaud] release version 2.0

doc/Controllers.pdf

-329 KB
Binary file not shown.

doc/PythonMcu.pdf

-341 KB
Binary file not shown.

doc/PythonMcu.tex

Lines changed: 0 additions & 271 deletions
This file was deleted.

0 commit comments

Comments
 (0)