Skip to content

A command line utility that generates reStructured (rst) files that are used for generating API documentation that is used with readthedocs.org

License

Notifications You must be signed in to change notification settings

kbaesler/Oedipus

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Oedipus

Oedipus is C# command line utility that will generate reStructured text (rst) files for .NET assemblies, that can be used for automatically generation API documentation using the Sphinx and Breathe projects.

Documentation

The utility requires that the -f and -o parameters are specified.

The -f parameter can be a list of assemblies or a single assembly file. (When the list of assmeblies are dependant on one another, it's best to list the assemblies in dependency order, starting with the lowest). The -o parameter is the output directory for the rst files.

Requirements

  • 4.5 .NET Framework
  • Visual Studio 2010+

Third Party Libraries

  • FluentCommandLineParser.1.4.1

About

A command line utility that generates reStructured (rst) files that are used for generating API documentation that is used with readthedocs.org

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages