Refactor and add documentation.

This commit is contained in:
Sergey Vartanov 2021-10-17 13:39:26 +03:00
parent d2813da063
commit 010368dfea
10 changed files with 24 additions and 3 deletions

View file

@ -0,0 +1,3 @@
"""
Documentation utilities.
"""

View file

@ -313,5 +313,5 @@ def convert(input_path: Path, output_path: Path) -> None:
if __name__ == "__main__": if __name__ == "__main__":
convert(Path("doc/readme.moi"), Path("README.md")) convert(Path("readme.moi"), Path("../../README.md"))
convert(Path("doc/contributing.moi"), Path(".github/CONTRIBUTING.md")) convert(Path("contributing.moi"), Path("../../.github/CONTRIBUTING.md"))

View file

@ -0,0 +1,3 @@
"""
Specific map features: roads, directions, etc.
"""

View file

@ -0,0 +1,3 @@
"""
Map geometry: dealing with coordinates, projections.
"""

View file

@ -58,7 +58,7 @@ def main() -> None:
elif arguments.command == "taginfo": elif arguments.command == "taginfo":
from map_machine.scheme import Scheme from map_machine.scheme import Scheme
from map_machine.taginfo import write_taginfo_project_file from doc.taginfo import write_taginfo_project_file
write_taginfo_project_file(Scheme(workspace.DEFAULT_SCHEME_PATH)) write_taginfo_project_file(Scheme(workspace.DEFAULT_SCHEME_PATH))

View file

@ -0,0 +1,3 @@
"""
OpenStreetMap-specific things.
"""

View file

@ -0,0 +1,3 @@
"""
Icons and points.
"""

View file

@ -0,0 +1,3 @@
"""
Tiles generation for slippy maps.
"""

View file

@ -0,0 +1,3 @@
"""
User interface.
"""