test: try to fix doc gen

This commit is contained in:
cclecle
2023-09-24 11:00:42 +01:00
parent af2aebd110
commit d9f133bb14
10 changed files with 15 additions and 18 deletions

View File

@@ -2,7 +2,7 @@ eclipse.preferences.version=1
encoding//src/pygamecfg/__init__.py=utf-8
encoding//src/pygamecfg/__main__.py=utf-8
encoding//src/pygamecfg/common_ut.py=utf-8
encoding//src/pygamecfg/core.py=utf-8
encoding//src/pygamecfg/core_gamecfg.py=utf-8
encoding//src/pygamecfg/game_cod4.py=utf-8
encoding//src/pygamecfg/game_ut2k4.py=utf-8
encoding//src/pygamecfg/game_ut99.py=utf-8

View File

@@ -1 +1 @@
# Usage
# Usage

View File

@@ -1,8 +1,7 @@
docs_dir: docs
site_name: pygamecfg
site_url: https://chacha.ddns.net/mkdocs-web/chacha/pygamecfg/latest/
site_description: A simple game config tool that provide bash API to read / write
game config files (cod, ut ...)
site_description: A simple ini parser / factory
site_author: chacha
repo_url: https://chacha.ddns.net/gitea/chacha/pygamecfg
use_directory_urls: false
@@ -37,21 +36,17 @@ theme:
icon: material/brightness-7
name: Switch to dark mode
plugins:
- localsearch
- search
- autorefs
- markdownextradata
- mermaid2
- localsearch
- mkdocstrings:
default_handler: python
handlers:
python:
paths:
- src
options:
filters:
- '!^_[^_]'
docstring_style: google
inherited_members: true
show_if_no_docstring: true
show_signature_annotations: true

View File

@@ -16,11 +16,6 @@ Main module __init__ file.
from importlib.metadata import distribution, version, PackageNotFoundError
import warnings
from .core import GameOptions_Factory
from . import game_cod4
from . import game_ut99
from . import game_ut2k4
try: # pragma: no cover
__version__ = version("pygamecfg")
@@ -41,3 +36,9 @@ try: # pragma: no cover
except PackageNotFoundError: # pragma: no cover
warnings.warn('can not read dist.metadata["Name"], assuming local test context, setting it to <pygamecfg>')
__Name__ = "pygamecfg"
from pygamecfg.core_gamecfg import GameOptions_Factory
from . import game_cod4
from . import game_ut99
from . import game_ut2k4

View File

@@ -18,7 +18,7 @@ from pathlib import Path
from pysimpleini import PySimpleINI
from .core import GameOption, OptionType
from .core_gamecfg import GameOption, OptionType
class GameOption_UT(GameOption):

View File

@@ -16,7 +16,7 @@ from typing import Union
import re
from os.path import join
from .core import GameOptions_Factory_Register, GameOption, OptionType
from .core_gamecfg import GameOptions_Factory_Register, GameOption, OptionType
class GameOption_COD4(GameOption):

View File

@@ -16,7 +16,7 @@ from typing import Union
from pysimpleini import KeyNotFoundError
from .core import GameOptions_Factory_Register, OptionType
from .core_gamecfg import GameOptions_Factory_Register, OptionType
from .tool_ini import PySimpleINI_GroupKeysInSection
from .common_ut import GameOption_UT

View File

@@ -16,7 +16,7 @@ from typing import Union
from pysimpleini import KeyNotFoundError, SectionNotFoundError
from .core import GameOptions_Factory_Register, OptionType
from .core_gamecfg import GameOptions_Factory_Register, OptionType
from .tool_ini import PySimpleINI_GroupKeysInSection
from .common_ut import GameOption_UT

1
src/pygamecfg/py.typed Normal file
View File

@@ -0,0 +1 @@
# PlaceHolder