Skip to content

Instantly share code, notes, and snippets.

@VictorieeMan
Last active January 14, 2022 11:25
Show Gist options
  • Select an option

  • Save VictorieeMan/2e106feedf8eb44a3eb78bbae342b786 to your computer and use it in GitHub Desktop.

Select an option

Save VictorieeMan/2e106feedf8eb44a3eb78bbae342b786 to your computer and use it in GitHub Desktop.
Documentation tools for Software

Simple docs:

-The Repository README.MD

-Github Gists

For more complex docs:

-What the python docs are using: Sphinx

-Works with Sphinx: Read The Docs

Especially for C++

-doxygen Haven't tired but it's supossed to be able to generate docs from your C++ code.

Recommendation:

-Notepad++ is a great editor for markdown. Install the MarkdownViewer++ plugin to get a built in previewer of .md files.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment