Start documenting the project

.gitignore

@@ -15,6 +15,8 @@
 *.so
 *.dylib
 *.dll
+*.pyd
+*.pyc
 
 # Fortran module files
 *.mod

docs/README.md

@@ -0,0 +1 @@
+# `bochscpu-python`

docs/api/.pages

@@ -0,0 +1,4 @@
+title: API Reference
+nav:
+    - Overview: README.md
+    - ...

docs/api/README.md

@@ -0,0 +1,20 @@
+<!-- markdownlint-disable -->
+
+# API Overview
+
+## Modules
+
+- No modules
+
+## Classes
+
+- No classes
+
+## Functions
+
+- No functions
+
+
+---
+
+_This file was automatically generated via [lazydocs](https://github.com/ml-tooling/lazydocs)._

docs/api/bochscpu.Hook.md

@@ -0,0 +1,169 @@
+<!-- markdownlint-disable -->
+
+# <kbd>class</kbd> `Hook`
+Class Hook 
+
+
+---
+
+### <kbd>property</kbd> Hook.after_execution
+
+Callback for Bochs `after_execution` callback 
+
+---
+
+### <kbd>property</kbd> Hook.before_execution
+
+Callback for Bochs `before_execution` callback 
+
+---
+
+### <kbd>property</kbd> Hook.cache_cntrl
+
+Callback for Bochs `cache_cntrl` callback 
+
+---
+
+### <kbd>property</kbd> Hook.clflush
+
+Callback for Bochs `clflush` callback 
+
+---
+
+### <kbd>property</kbd> Hook.cnear_branch_not_taken
+
+Callback for Bochs `cnear_branch_not_taken` callback 
+
+---
+
+### <kbd>property</kbd> Hook.cnear_branch_taken
+
+Callback for Bochs `cnear_branch_taken` callback 
+
+---
+
+### <kbd>property</kbd> Hook.ctx
+
+A raw pointer to the Session object 
+
+---
+
+### <kbd>property</kbd> Hook.exception
+
+Callback for Bochs `exception` callback 
+
+---
+
+### <kbd>property</kbd> Hook.far_branch
+
+Callback for Bochs `far_branch` callback 
+
+---
+
+### <kbd>property</kbd> Hook.hlt
+
+Callback for Bochs `hlt` callback 
+
+---
+
+### <kbd>property</kbd> Hook.hw_interrupt
+
+Callback for Bochs `hw_interrupt` callback 
+
+---
+
+### <kbd>property</kbd> Hook.inp
+
+Callback for Bochs `inp` callback 
+
+---
+
+### <kbd>property</kbd> Hook.inp2
+
+Callback for Bochs `inp2` callback 
+
+---
+
+### <kbd>property</kbd> Hook.interrupt
+
+Callback for Bochs `interrupt` callback 
+
+---
+
+### <kbd>property</kbd> Hook.lin_access
+
+Callback for Bochs `lin_access` callback 
+
+---
+
+### <kbd>property</kbd> Hook.mwait
+
+Callback for Bochs `mwait` callback 
+
+---
+
+### <kbd>property</kbd> Hook.opcode
+
+Callback for Bochs `opcode` callback 
+
+---
+
+### <kbd>property</kbd> Hook.outp
+
+Callback for Bochs `outp` callback 
+
+---
+
+### <kbd>property</kbd> Hook.phy_access
+
+Callback for Bochs `phy_access` callback 
+
+---
+
+### <kbd>property</kbd> Hook.prefetch_hint
+
+Callback for Bochs `prefetch_hint` callback 
+
+---
+
+### <kbd>property</kbd> Hook.repeat_iteration
+
+Callback for Bochs `repeat_iteration` callback 
+
+---
+
+### <kbd>property</kbd> Hook.reset
+
+Callback for Bochs `reset` callback 
+
+---
+
+### <kbd>property</kbd> Hook.tlb_cntrl
+
+Callback for Bochs `tlb_cntrl` callback 
+
+---
+
+### <kbd>property</kbd> Hook.ucnear_branch
+
+Callback for Bochs `ucnear_branch` callback 
+
+---
+
+### <kbd>property</kbd> Hook.vmexit
+
+Callback for Bochs `vmexit` callback 
+
+---
+
+### <kbd>property</kbd> Hook.wrmsr
+
+Callback for Bochs `wrmsr` callback 
+
+
+
+
+
+---
+
+_This file was automatically generated via [lazydocs](https://github.com/ml-tooling/lazydocs)._

docs/api/bochscpu.InstructionType.md

@@ -0,0 +1,15 @@
+<!-- markdownlint-disable -->
+
+# <kbd>class</kbd> `InstructionType`
+
+
+
+
+
+
+
+
+
+---
+
+_This file was automatically generated via [lazydocs](https://github.com/ml-tooling/lazydocs)._

docs/api/bochscpu.Segment.md

@@ -0,0 +1,43 @@
+<!-- markdownlint-disable -->
+
+# <kbd>class</kbd> `Segment`
+Segment class 
+
+
+---
+
+### <kbd>property</kbd> Segment.attr
+
+Get/Set the Segment `attr` attribute 
+
+---
+
+### <kbd>property</kbd> Segment.base
+
+Get/Set the Segment `base` attribute 
+
+---
+
+### <kbd>property</kbd> Segment.limit
+
+Get/Set the Segment `limit` attribute 
+
+---
+
+### <kbd>property</kbd> Segment.present
+
+Get/Set the Segment `present` attribute 
+
+---
+
+### <kbd>property</kbd> Segment.selector
+
+Get/Set the Segment `selector` attribute 
+
+
+
+
+
+---
+
+_This file was automatically generated via [lazydocs](https://github.com/ml-tooling/lazydocs)._

docs/api/bochscpu.Session.md

@@ -0,0 +1,33 @@
+<!-- markdownlint-disable -->
+
+# <kbd>class</kbd> `Session`
+Class session 
+
+
+---
+
+### <kbd>property</kbd> Session.cpu
+
+Get the CPU associated to the session 
+
+---
+
+### <kbd>property</kbd> Session.missing_page_handler
+
+Set the missing page callback 
+
+
+---
+
+### <kbd>handler</kbd> Session.run
+
+---
+
+### <kbd>handler</kbd> Session.stop
+
+
+
+
+---
+
+_This file was automatically generated via [lazydocs](https://github.com/ml-tooling/lazydocs)._