add api documentation

.gitignore

@@ -71,4 +71,7 @@ docs/_build/
 .vscode/
 
 # Pyenv
-.python-version
+.python-version
+
+# mkdocs output
+/site/

README.md

@@ -138,5 +138,5 @@ for (depth, element) in model.elements_dfs:
 - maturin must be installed: `pip install maturin` if it isn't
 - create a venv in the cloned source: `python -m venv .venv`
 - build the wheel and directly install it in the venv: `maturin develop`
-- activate the venv in a shell: `.venv/Scripts/activate` or `.venv\Scripts\Activate.ps1`
+- activate the venv in a shell: `source .venv/bin/activate` or `.venv\Scripts\Activate.ps1`
 - run python in the shell with the venv

autosar_data.pyi

@@ -168,7 +168,9 @@ class Element:
  """
  def __repr__(self) -> str: ...
  def __str__(self) -> str: ...
- def serialize(self) -> str: ...
+ def serialize(self) -> str:
+ """serialize this element and its sub elements int oa string. This string is valid xml, but it is not a vaild arxml file"""
+ ...
  parent: Element
  """reference to the parent of this element"""
  element_name: ElementName
@@ -218,7 +220,7 @@ class Element:
  sub_elements: ElementsIterator
  """an iterator over all sub elements in the content of this element. It skips character data content items"""
  elements_dfs: ElementsDfsIterator
- """dpeth first search iterator for this element and all of its sub elements"""
+ """depth first search iterator for this element and all of its sub elements"""
  character_data: CharacterData
  """character content of this element, if any. For elements with ContentType=Element, or empty elements this is None"""
  def remove_character_data(self) -> None: