Easily document any object to a markdown file
Project description
- ridoculous
- ridoculous.core
ridoculous
ridoculous.core.Ridoculous(self, objects: List[object] = None)
None
Ridoculous.__init__(self, objects: List[object] = None)
None
Ridoculous.make_doc_list(self)
None
Ridoculous.write(self, filename: str = 'GENERATED_README.md')
None
ridoculous.core
ridoculous.core.ClassRDoc(self, obj: object = None)
None
ClassRDoc.__init__(self, obj: object = None)
None
ClassRDoc.__repr__(self)
None
ClassRDoc.__str__(self)
None
ridoculous.core.FunctionRDoc(self, obj: object = None)
None
FunctionRDoc.__init__(self, obj: object = None)
None
FunctionRDoc.__repr__(self)
None
FunctionRDoc.__str__(self)
None
ridoculous.core.ModuleRDoc(self, obj: object = None)
None
ModuleRDoc.__init__(self, obj: object = None)
None
ModuleRDoc.__repr__(self)
None
ModuleRDoc.__str__(self)
None
ModuleRDoc.get_rdoc_list(self)
None
ridoculous.core.RDocObject(self, /, *args, **kwargs)
RDocObject(name, modules)
RDocObject.__getnewargs__(self)
Return self as a plain tuple. Used by copy and pickle.
RDocObject.__new__(_cls, name: str, modules: List[ridoculous.core.ModuleRDoc])
Create new instance of RDocObject(name, modules)
RDocObject.__repr__(self)
Return a nicely formatted representation string
RDocObject._asdict(self)
Return a new OrderedDict which maps field names to their values.
RDocObject._replace(_self, **kwds)
Return a new RDocObject object replacing specified fields with new values
ridoculous.core.Ridoculous(self, objects: List[object] = None)
None
Ridoculous.__init__(self, objects: List[object] = None)
None
Ridoculous.make_doc_list(self)
None
Ridoculous.write(self, filename: str = 'GENERATED_README.md')
None
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
ridoculous-0.0.3.tar.gz
(3.7 kB
view hashes)
