Skip to content

Commit 0362387

Browse files
committed
Fixed Documentation
- Fixed a few documentation issues.
1 parent 901d2cd commit 0362387

File tree

3 files changed

+9
-8
lines changed

3 files changed

+9
-8
lines changed

Python/PyPi-Readme.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ Enphase-API is an unofficial project providing an API wrapper and the documentat
44

55
This project is focusing primarily on the Enphase® "IQ Gateway" (formerly "IQ Envoy") system, the gateway for Enphase®'s IQ7 and IQ8 Microinverters used on solar panels to convert Direct Current (DC) to Alternating Current (AC) to be directly consumed by the home.
66

7-
WARNING: This project currently predominantly consumes the same local API that the local Gateway web administration portal consumes and Enphase® may choose to change it in subsequent updates without warning.
7+
> **Warning**
8+
> This project currently predominantly consumes the same local API that the local Gateway web administration portal consumes and Enphase® may choose to change it in subsequent updates without warning.
89
910
## Installing Enphase-API
1011

@@ -16,13 +17,13 @@ $ python -m pip install Enphase_API
1617

1718
## Documentation
1819

19-
The documentation for the wrapper and the API itself is at [Enphase-API Documentation GitHub](https://github.com/Matthew1471/Enphase-API/Documentation/README.adoc)
20+
The documentation for the wrapper and the API itself is at [Enphase-API Documentation GitHub](https://github.com/Matthew1471/Enphase-API/tree/main/Documentation/README.adoc)
2021

2122
## Copyright and License
2223

2324
### Code
2425

25-
Copyright (C) 2023 Matthew1471
26+
Copyright ©️ 2023 Matthew1471
2627

2728
This program is free software: you can redistribute it and/or modify
2829
it under the terms of the GNU General Public License as published by
@@ -39,13 +40,13 @@ along with this program. If not, see <https://www.gnu.org/licenses/>.
3940

4041
### Documentation
4142

42-
Copyright (c) 2023 Matthew1471.
43+
Copyright ©️ 2023 Matthew1471.
4344

4445
Permission is granted to copy, distribute and/or modify this document
4546
under the terms of the GNU Free Documentation License, Version 1.3
4647
or any later version published by the Free Software Foundation;
4748
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
48-
A copy of the license is included in the file [Enphase-API Documentation License](https://github.com/Matthew1471/Enphase-API/Documentation/LICENSE.md).
49+
A copy of the license is included in the file [Enphase-API Documentation License](https://github.com/Matthew1471/Enphase-API/tree/main/Documentation/LICENSE.md).
4950

5051
## Authors
5152

Python/pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ description = "An unofficial Enphase® API that predominantly focuses on the loc
2828
#
2929
# This field corresponds to the "Description" metadata field:
3030
# https://packaging.python.org/specifications/core-metadata/#description-optional
31-
readme = "PyPi Readme.md" # Optional
31+
readme = "PyPi-Readme.md" # Optional
3232

3333
# Specify which Python versions you support.
3434
# In contrast to the 'Programming Language' classifiers above, 'pip install' will check this and refuse to install the project if the version does not match.
@@ -128,7 +128,7 @@ dev = ["pillow", "unicorn_hat_sim"]
128128
[project.urls] # Optional
129129
"Homepage" = "https://github.com/Matthew1471/Enphase-API/"
130130
"Bug Reports" = "https://github.com/Matthew1471/Enphase-API/issues"
131-
"Documentation" = "https://github.com/Matthew1471/Enphase-API/tree/master/Documentation"
131+
"Documentation" = "https://github.com/Matthew1471/Enphase-API/tree/main/Documentation"
132132
"Say Thanks!" = "https://Matthew1471.co.uk/Contact.php"
133133
"Source" = "https://github.com/Matthew1471/Enphase-API/"
134134

README.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ along with this program. If not, see <https://www.gnu.org/licenses/>.
6565

6666
=== Documentation
6767

68-
Copyright (c) 2023 Matthew1471.
68+
Copyright (C) 2023 Matthew1471.
6969

7070
Permission is granted to copy, distribute and/or modify this document
7171
under the terms of the GNU Free Documentation License, Version 1.3

0 commit comments

Comments
 (0)