marc-q / doctra Goto Github PK

This project needs some tests that prevent some bugs from sneaking in.

Implement automatic link creation.

To use this offline or without GitHub, it would be great to have the ability to export to HTML files.

• Implement an easy way to introduce new export formats.
• Define how the exported page should look.
• Write a new exporter that uses the modules from the task above.
• Write a wiki page on how to write a new exporter.

Implement a configuration system that uses files to store the values. This would be used by a "project" file, which holds all the project dependent settings like the directory where the documentation will be stored or which files to parse.

TODO

• Decide on the file format to use.

It would be nice to have the ability to document structures.

TODO:

• Plan what informations goes into the object.
• Find a pattern that identifies a doc string for structures.
• Implement and document the object.
• Implement the export in markdown.

This project needs an icon. 🎨

Since grammar and me doesn't go well together, i need your help to correct my mistakes and hopefully show me how to avoid them in the future.

Implement a parser that can parse different file formats.

This Issue contains all the information during the first implementation of the tag system.