CCExtractor Development

Getting Started: Nephos: Improve Developer Documentation

The current developer's documentation is not sufficient and lacks at many levels. Developer documentation should contain per page all the function doc-strings and also the list of global variables used. There should be (but not necessarily) link to the side effects of the function which will be present on a different page. The current documentation was generated using PyDoc. Below are a few resources to try out different methods of the generation of documentation from docstrings. The best part is that it will automatically follow the folder schema.

https://python-docs.readthedocs.io/en/latest/writing/documentation.html https://stackoverflow.com/questions/26587763/how-to-generate-documentation-using-pydoc

Task tags

  • python
  • github pages
  • pydocs
  • docstrings

Students who completed this task

T1duS

Task type

  • code Code
  • chrome_reader_mode Documentation / Training
  • done_all Quality Assurance
close

2018