Contributing

Documentation

  • Shell code must be added like this:

.. prompt:: bash

   shell command here
  • When adding python code examples, dryparse objects must link to their corresponding documentation:

    Source:
    .. autolink-preface:: from dryparse.objects import Command
    
    .. code:: python
    
       cmd = Command("test")
    
    Result:
    cmd = Command("test")
    

    For more info, see the documentation of sphinx-codeautolink.