dexy 2.2 1.9 L4 Python is a free-form literate documentation tool for writing any kind of technical document incorporating code.

Related tags

Documentation dexy
Overview

Dexy

Dexy is open source automation software with features especially designed for documentation and reporting. More information at http://dexy.it

Docs

The home page for all documentation is http://dexy.it/docs

Dexy's User Guide http://guide.dexy.it

Dexy's Developer Guide http://dexy.github.io/dexy

Source

Dexy's source code is available from http://github.com/dexy/dexy

The 'stable' branch contains the most recent release of Dexy. The 'develop' branch contains the most recent development version of Dexy.

From version 1.1 and up, Dexy will only run under Python 3. (However Dexy can be used to document almost any programming language.)

Tests

Dexy uses nose to run tests.

Additional Python package requirements for tests are in dev-requirements.txt

pip install -r dev-requirements.txt

Comments
  • Dexy could not find an input document, but says it exists !

    Dexy could not find an input document, but says it exists !

    Here is my dexy output :

    ERROR while running docsrc/README.md|jinja: No document named 'shell-autodoc.sh' is available as an input to 'docsrc/README.md|jinja'. There are 11 input documents available, their keys have been written to dexy's log. Did you mean 'shell-autodoc.sh'?

    However, "shell-autodoc.sh" seems to be declared in my dexy.yaml :

    docsrc/README.md|jinja:
       - perl/check_test.pl|idio
       - shell-autodoc.sh:
          - contents: "./check_fs.pl --autodoc"
       - shell-autodoc.sh|sh:
          - contents: "perl ./perl/check_test.pl --autodoc"
          - perl/check_test.pl
          - perl/lib/Nagios/Autoconf.pm
       - shell-autoconf.sh:
          - contents: "./check_fs.pl -H 192.168.1.2 -w 60 -c 75 --autoconf"
       - shell-autoconf.sh|sh:
          - contents: "perl ./perl/check_test.pl -H 192.168.1.2 -w 60 -c 75 --autoconf"
          - perl/check_test.pl
          - perl/lib/Nagios/Autoconf.pm
       - shell-autoconf-command.sh:
          - contents: "./check_fs.pl -H 192.168.1.2 -w 60 -c 75 --autoconf --commandline"
       - shell-autoconf-command.sh|sh:
          - contents: "perl ./perl/check_test.pl -H 192.168.1.2 -w 60 -c 75 --autoconf --commandline"
          - perl/check_test.pl
          - perl/lib/Nagios/Autoconf.pm
       - shell-version.sh|pyg:
          - contents: "perl ./perl/check_test.pl --version"
       - shell-version.sh|sh:
          - contents: "perl ./perl/check_test.pl --version"
          - perl/check_test.pl
          - perl/lib/Nagios/Autoconf.pm
    

    And here are the logs :

    dexy - INFO - starting logging for dexy
    dexy - INFO - using config file 'dexy.yaml'
    dexy - INFO - (state:running) 2e9c65b83c16e18b200ab152a66b829d doc:docsrc/README.md|jinja: running...
    dexy - INFO - (state:running) 2ab22d6ab6c137e0921a83c9b7f733cc doc:perl/check_test.pl|idio: using cache for self and any children
    dexy - INFO - (state:running) 2ed34296a5a401404f0eddd16eb7ea32 doc:shell-autodoc.sh: running...
    dexy - INFO - (state:running) f635b23922e5c51f9123452622ffa93d doc:shell-autodoc.sh|sh: running...
    dexy - INFO - (state:running) 1cd7efe54546548628297753f0c614f6 doc:perl/check_test.pl: using cache for self and any children
    dexy - INFO - (state:running) 6481df9378878720a292e492b2495a55 doc:perl/lib/Nagios/Autoconf.pm: using cache for self and any children
    dexy - INFO - (state:running) 416cc0ae71101689c5b6ea6399ce5dd1 doc:shell-autoconf.sh: running...
    dexy - INFO - (state:running) 70476354e84b16e038a67e89fd127385 doc:shell-autoconf.sh|sh: running...
    dexy - INFO - (state:running) 1cd7efe54546548628297753f0c614f6 doc:perl/check_test.pl: using cache for self and any children
    dexy - INFO - (state:running) 6481df9378878720a292e492b2495a55 doc:perl/lib/Nagios/Autoconf.pm: using cache for self and any children
    dexy - INFO - (state:running) fe0437ae7c2051a9b5dc57aec7ec23ed doc:shell-autoconf-command.sh: running...
    dexy - INFO - (state:running) 0c1a1e76e7a9db62642d657dd35df3ea doc:shell-autoconf-command.sh|sh: running...
    dexy - INFO - (state:running) 1cd7efe54546548628297753f0c614f6 doc:perl/check_test.pl: using cache for self and any children
    dexy - INFO - (state:running) 6481df9378878720a292e492b2495a55 doc:perl/lib/Nagios/Autoconf.pm: using cache for self and any children
    dexy - INFO - (state:running) 94e3e0e00c18e8ee4e71d34c32d62e25 doc:shell-version.sh|pyg: running...
    dexy - INFO - (state:running) 649e3f4e5663b6f5d416bb6b94a01848 doc:shell-version.sh|sh: running...
    dexy - INFO - (state:running) 1cd7efe54546548628297753f0c614f6 doc:perl/check_test.pl: using cache for self and any children
    dexy - INFO - (state:running) 6481df9378878720a292e492b2495a55 doc:perl/lib/Nagios/Autoconf.pm: using cache for self and any children
    dexy - WARNING - (state:running) 2e9c65b83c16e18b200ab152a66b829d doc:docsrc/README.md|jinja: Listing documents which are available:
    dexy - WARNING - (state:running) 2e9c65b83c16e18b200ab152a66b829d doc:docsrc/README.md|jinja:   perl/check_test.pl
    dexy - WARNING - (state:running) 2e9c65b83c16e18b200ab152a66b829d doc:docsrc/README.md|jinja:   perl/check_test.pl|idio
    dexy - WARNING - (state:running) 2e9c65b83c16e18b200ab152a66b829d doc:docsrc/README.md|jinja:   perl/lib/Nagios/Autoconf.pm
    dexy - WARNING - (state:running) 2e9c65b83c16e18b200ab152a66b829d doc:docsrc/README.md|jinja:   shell-autoconf-command.sh
    dexy - WARNING - (state:running) 2e9c65b83c16e18b200ab152a66b829d doc:docsrc/README.md|jinja:   shell-autoconf-command.sh|sh
    dexy - WARNING - (state:running) 2e9c65b83c16e18b200ab152a66b829d doc:docsrc/README.md|jinja:   shell-autoconf.sh
    dexy - WARNING - (state:running) 2e9c65b83c16e18b200ab152a66b829d doc:docsrc/README.md|jinja:   shell-autoconf.sh|sh
    dexy - WARNING - (state:running) 2e9c65b83c16e18b200ab152a66b829d doc:docsrc/README.md|jinja:   shell-autodoc.sh
    dexy - WARNING - (state:running) 2e9c65b83c16e18b200ab152a66b829d doc:docsrc/README.md|jinja:   shell-autodoc.sh|sh
    dexy - WARNING - (state:running) 2e9c65b83c16e18b200ab152a66b829d doc:docsrc/README.md|jinja:   shell-version.sh|pyg
    dexy - WARNING - (state:running) 2e9c65b83c16e18b200ab152a66b829d doc:docsrc/README.md|jinja:   shell-version.sh|sh
    dexy - WARNING - ERROR while running docsrc/README.md|jinja: No document named 'shell-autodoc.sh'
    is available as an input to 'docsrc/README.md|jinja'.
    There are 11 input documents available, their keys have been written to dexy's log.
    Did you mean 'shell-autodoc.sh'?
    
    opened by Orabig 5
  • ipynbcasper filter

    ipynbcasper filter

    Filter for running arbitrary casper.js scripts against the ipython notebook server.

    Features:

    • [x] Be able to run ipython notebook directly in any subdirectory of project (means original ipynb file(s) may be altered)
    • [x] Include bundled scripts for some common tasks/scenarios.
    filters 
    opened by ananelson 5
  • Idio plugin doesn't handle comments with '///' instead of '###'

    Idio plugin doesn't handle comments with '///' instead of '###'

    Using a source file, "Hello.java" as input:

    /// @export "Hello class"
    class Hello {
    
    /// @export "method1"
        public void meth1() {}
    /// @export "method2"
        public void meth2() {}
    /// @end
    }
    

    And a hello.txt with:

    Method 2 is the most important:
    {{ d['Hello.java|idio']['method2'] }}
    
    It calls Method 1
    {{ d['Hello.java|idio']['method1'] }}
    
    This is the fundamental definition of the Hello class
    {{ d['Hello.java|pyg'] }}
    

    I get the following stacktrace:

    batch id is 2
    sorting 3 documents into run order, there are 2 total dependencies
    ratio of dependencies to documents is 0.7
    Error occurred while running hello.txt|jinja
    Original traceback:
    dexy.exe :   File "C:\Python27\lib\site-packages\dexy\artifact.py", line 288, in run
    At line:1 char:5
    + dexy <<<<  2>&1 > err.log
        + CategoryInfo          : NotSpecified: (  File "C:\Pyth...ine 288, in run:String) [], RemoteException
        + FullyQualifiedErrorId : NativeCommandError
    
        filter_instance.process()
      File "C:\Python27\lib\site-packages\dexy\filters\templating_filters.py", line 150, in process
        self.handle_jinja_exception(e)
      File "C:\Python27\lib\site-packages\dexy\filters\templating_filters.py", line 133, in handle_jinja_exception
        raise JinjaFilterException("\n".join(result))
    Traceback (most recent call last):
      File "C:\Python27\Scripts\dexy-script.py", line 9, in <module>
        load_entry_point('dexy==0.5.1', 'console_scripts', 'dexy')()
      File "C:\Python27\lib\site-packages\dexy\commands.py", line 18, in run
        args.parse_and_run_command(sys.argv[1:], MOD, default_command=Constants.DEFAULT_COMMAND)
      File "C:\Python27\lib\site-packages\modargs\args.py", line 360, in parse_and_run_command
        command_module(mod, command, options)
      File "C:\Python27\lib\site-packages\modargs\args.py", line 280, in command_module
        return function(**options)
      File "C:\Python27\lib\site-packages\dexy\commands.py", line 98, in dexy_command
        controller = run_dexy(locals())
      File "C:\Python27\lib\site-packages\dexy\commands.py", line 107, in run_dexy
        controller.run()
      File "C:\Python27\lib\site-packages\dexy\controller.py", line 77, in run
        self.docs = [doc.run() for doc in self.docs]
      File "C:\Python27\lib\site-packages\dexy\document.py", line 346, in run
        artifact.run()
      File "C:\Python27\lib\site-packages\dexy\artifact.py", line 300, in run
        raise e
    dexy.filters.templating_filters.JinjaFilterException: There is a problem with hello.txt|jinja
    
    A problem was detected at line 10 of artifacts\b07606b9ed3534f0b6199698a9d88bb8.txt
    
    WARNING: line number may not be accurate, check elsewhere in your file if the excerpt does not contain the undefined it
    em from the stack trace.
    ==================================================
    
        This is the fundamental definition of the Hello class
    >>> {{ d['hello.java|pyg'] }}
    ==================================================
    The error is: 'unicode object' has no attribute 'method2'
    Traceback (most recent call last):
      File "C:\Python27\lib\site-packages\dexy\filters\templating_filters.py", line 148, in process
        template.stream(template_data).dump(self.artifact.filepath())
      File "C:\Python27\lib\site-packages\jinja2\environment.py", line 1072, in dump
        fp.writelines(iterable)
      File "C:\Python27\lib\site-packages\jinja2\environment.py", line 1116, in next
        return self._next()
      File "C:\Python27\lib\site-packages\jinja2\environment.py", line 918, in generate
        yield self.environment.handle_exception(exc_info, True)
      File "<template>", line 10, in top-level template code
    UndefinedError: 'unicode object' has no attribute 'method2'
    

    While using this file

    ### @export "Hello class"
    class Hello {
    
    ### @export "method1"
        public void meth1() {}
    ### @export "method2"
        public void meth2() {}
    ### @end
    }
    

    Provides the expected results.

    Here's my .dexy file

    {
        "*.txt|jinja" : {
            "inputs" : ["Hello.java|pyg", "Hello.java|idio"]
        }
    }
    
    opened by ryanfreckleton 5
  • Custom name output {name} gives original full path

    Custom name output {name} gives original full path

    From http://dexy.github.io/dexy-user-guide/

    - output-name: "%(name)s-file.abc"
    

    Gives:

    ./baz/1.txt -> ./baz/baz/1.txt-file.abc
    

    I think this should be

    ./baz/1.txt -> ./baz/1.txt-file.abc
    

    or even

    ./baz/1.txt -> ./baz/1-file.abc
    

    If this is working as intended, may I request that we add another couple of variables to the evaluation context for custom names to support this? I don't mind doing it...

    opened by jamespjh 4
  • OrderedDict is in collections module in python-2.7+

    OrderedDict is in collections module in python-2.7+

    Try to first import OrderedDict from the collections module and then from ordereddict module as a fall back.

    See: http://docs.python.org/library/collections.html

    opened by tomspur 4
  • idio sections for sql scripts

    idio sections for sql scripts

    Unfortunately, sql do not support '//' or '#' type of comments. Only comments types that is allowed are

    • -- < comment >
    • /* < comment > */

    Is it possible to tune idio somehow, so it would be possible to create sections like this: --- @export "some_query" or like this /* section "some_query" */

    opened by Arkoniak 3
  • pycon filter lacked 'INITIAL_PROMPT' setting, causing crash on OSX

    pycon filter lacked 'INITIAL_PROMPT' setting, causing crash on OSX

    can't run pycon filter on OSX. attached patch fixes by setting an INITIAL_PROMPT

    what it looks like when I start python:

    worblehat ~/ics/ext/dexy$ python
    Python 2.7.3 (default, May 13 2012, 11:41:02) 
    [GCC 4.2.1 (Based on Apple Inc. build 5658) (LLVM build 2335.15.00)] on darwin
    Type "help", "copyright", "credits" or "license" for more information.
    >>> note_the_space_between('>>>', 'and rest of line')
    

    the error:

    worblehat ~/ics/ext/dexy/test-examples$ dexy -danger --loglevel DEBUG
    batch id is 9
    sorting 16 documents into run order, there are 2 total dependencies
    ratio of dependencies to documents is 0.1
    ERROR in test-idio.py|idio|pycon|pyg|l (in filter 'pycon' - step 2 of 4)
    Traceback (most recent call last):
      File "/usr/local/bin/dexy", line 8, in <module>
        load_entry_point('dexy==0.6.0', 'console_scripts', 'dexy')()
      File "/Users/flip/ics/ext/dexy/dexy/commands.py", line 55, in run
        args.parse_and_run_command(sys.argv[1:], MOD, default_command=Constants.DEFAULT_COMMAND)
      File "/Library/Python/2.7/site-packages/modargs/args.py", line 375, in parse_and_run_command
        command_module(mod, command, options)
      File "/Library/Python/2.7/site-packages/modargs/args.py", line 283, in command_module
        function(**options)
      File "/Users/flip/ics/ext/dexy/dexy/commands.py", line 150, in dexy_command
        controller = run_dexy(locals())
      File "/Users/flip/ics/ext/dexy/dexy/commands.py", line 175, in run_dexy
        controller.run()
      File "/Users/flip/ics/ext/dexy/dexy/controller.py", line 87, in run
        self.docs = [doc.run() for doc in self.docs]
      File "/Users/flip/ics/ext/dexy/dexy/document.py", line 376, in run
        artifact.run()
      File "/Users/flip/ics/ext/dexy/dexy/artifact.py", line 426, in run
        raise e
    dexy.commands.InternalDexyProblem: 
    Oops! You may have found a bug in Dexy.
            The developer would really appreciate if you copy and paste this entire message
            and the Traceback above it into a bug report at http://dexy.tenderapp.com.
            Your version of Dexy is 0.6.0
            Your platform is Darwin
    PythonPexpectReplFilter failed at matching initial prompt within 8 seconds. Received 'Python 2.7.3 (default, May 13 2012, 11:41:02) 
    [GCC 4.2.1 (Based on Apple Inc. build 5658) (LLVM build 2335.15.00)] on darwin
    Type "help", "copyright", "credits" or "license" for more information.
    >>> ', tried to match with '['\n>>>', '\n...']'
    Exact characters received:
    chr 00: 80
    chr 01: 121
    chr 02: 116
    chr 03: 104
    chr 04: 111
    chr 05: 110
    chr 06: 32
    chr 07: 50
    chr 08: 46
    chr 09: 55
    chr 10: 46
    chr 11: 51
    chr 12: 32
    chr 13: 40
    chr 14: 100
    chr 15: 101
    chr 16: 102
    chr 17: 97
    chr 18: 117
    chr 19: 108
    chr 20: 116
    chr 21: 44
    chr 22: 32
    chr 23: 77
    chr 24: 97
    chr 25: 121
    chr 26: 32
    chr 27: 49
    chr 28: 51
    chr 29: 32
    chr 30: 50
    chr 31: 48
    chr 32: 49
    chr 33: 50
    chr 34: 44
    chr 35: 32
    chr 36: 49
    chr 37: 49
    chr 38: 58
    chr 39: 52
    chr 40: 49
    chr 41: 58
    chr 42: 48
    chr 43: 50
    chr 44: 41
    chr 45: 32
    chr 46: 13
    chr 47: 10
    chr 48: 91
    chr 49: 71
    chr 50: 67
    chr 51: 67
    chr 52: 32
    chr 53: 52
    chr 54: 46
    chr 55: 50
    chr 56: 46
    chr 57: 49
    chr 58: 32
    chr 59: 40
    chr 60: 66
    chr 61: 97
    chr 62: 115
    chr 63: 101
    chr 64: 100
    chr 65: 32
    chr 66: 111
    chr 67: 110
    chr 68: 32
    chr 69: 65
    chr 70: 112
    chr 71: 112
    chr 72: 108
    chr 73: 101
    chr 74: 32
    chr 75: 73
    chr 76: 110
    chr 77: 99
    chr 78: 46
    chr 79: 32
    chr 80: 98
    chr 81: 117
    chr 82: 105
    chr 83: 108
    chr 84: 100
    chr 85: 32
    chr 86: 53
    chr 87: 54
    chr 88: 53
    chr 89: 56
    chr 90: 41
    chr 91: 32
    chr 92: 40
    chr 93: 76
    chr 94: 76
    chr 95: 86
    chr 96: 77
    chr 97: 32
    chr 98: 98
    chr 99: 117
    chr 100: 105
    chr 101: 108
    chr 102: 100
    chr 103: 32
    chr 104: 50
    chr 105: 51
    chr 106: 51
    chr 107: 53
    chr 108: 46
    chr 109: 49
    chr 110: 53
    chr 111: 46
    chr 112: 48
    chr 113: 48
    chr 114: 41
    chr 115: 93
    chr 116: 32
    chr 117: 111
    chr 118: 110
    chr 119: 32
    chr 120: 100
    chr 121: 97
    chr 122: 114
    chr 123: 119
    chr 124: 105
    chr 125: 110
    chr 126: 13
    chr 127: 10
    chr 128: 84
    chr 129: 121
    chr 130: 112
    chr 131: 101
    chr 132: 32
    chr 133: 34
    chr 134: 104
    chr 135: 101
    chr 136: 108
    chr 137: 112
    chr 138: 34
    chr 139: 44
    chr 140: 32
    chr 141: 34
    chr 142: 99
    chr 143: 111
    chr 144: 112
    chr 145: 121
    chr 146: 114
    chr 147: 105
    chr 148: 103
    chr 149: 104
    chr 150: 116
    chr 151: 34
    chr 152: 44
    chr 153: 32
    chr 154: 34
    chr 155: 99
    chr 156: 114
    chr 157: 101
    chr 158: 100
    chr 159: 105
    chr 160: 116
    chr 161: 115
    chr 162: 34
    chr 163: 32
    chr 164: 111
    chr 165: 114
    chr 166: 32
    chr 167: 34
    chr 168: 108
    chr 169: 105
    chr 170: 99
    chr 171: 101
    chr 172: 110
    chr 173: 115
    chr 174: 101
    chr 175: 34
    chr 176: 32
    chr 177: 102
    chr 178: 111
    chr 179: 114
    chr 180: 32
    chr 181: 109
    chr 182: 111
    chr 183: 114
    chr 184: 101
    chr 185: 32
    chr 186: 105
    chr 187: 110
    chr 188: 102
    chr 189: 111
    chr 190: 114
    chr 191: 109
    chr 192: 97
    chr 193: 116
    chr 194: 105
    chr 195: 111
    chr 196: 110
    chr 197: 46
    chr 198: 13
    chr 199: 10
    chr 200: 27
    chr 201: 91
    chr 202: 63
    chr 203: 49
    chr 204: 48
    chr 205: 51
    chr 206: 52
    chr 207: 104
    chr 208: 62
    chr 209: 62
    chr 210: 62
    chr 211: 32
    The developer might need to set a longer INITIAL_PROMPT_TIMEOUT or the regexp may be wrong.
    
    opened by mrflip 3
  • dexy.controller.find_filters is broken

    dexy.controller.find_filters is broken

    Seems that the code works only when dexy is run from a development work tree, where dexy filters are located at "dexy/dexy/filters", but no dexy filter is loaded when dexy is installed, and its path is something like: "dexy-0.5.0-py2.7.egg/dexy/filters". The results is empty filters and confusing error messages.

    opened by nirs 3
  • Add bibtex-executable option to latex plugin

    Add bibtex-executable option to latex plugin

    The addition of this setting allow the user to set the bibtex executable to something else, such as 'biber' (for use with the biblatex latex package).

    The default value is 'bibtex', which means this change will not break anything for existing users.

    opened by darcamo 2
  • Dexy Getting Started Guide

    Dexy Getting Started Guide

    In the HTML example it looks like you ended the code to be

    from cmath import phase print phase(complex(-1.0, 0.0))

    but instead script.py includes

    for i in range(0, 5): print i

    opened by emcee21 2
  • data objects appearing without 'storage' attributes

    data objects appearing without 'storage' attributes

    File "/home/ana/dev/dexy/dexy/reporters/run/classes.py", line 104, in run doc.initial_data.storage AttributeError: 'Generic' object has no attribute 'storage'

    bug 
    opened by ananelson 2
  • dexy fails when including libraries in R code

    dexy fails when including libraries in R code

    I'm including an R file and its output using the rintbatch filter to get the console output. This works fine as long as I only use absolute base-R functionality, but as soon as I include a single library(), such as library(tidyverse), dexy returns a not printable in the output.

    opened by lukaskawerau 3
  • No data found for files in subfolders under windows.

    No data found for files in subfolders under windows.

    The following dexy.yaml (with any files test1.rst and test2.rst):

    - test1.rst
    - subfolder/test2.rst
    

    fails with:

    ERROR while running subfolder/test2.rst: No data found for 'subfolder/test2.rst', did you reference a file that doesn't exist?
    

    This is under windows 8 and 10 with latest develop branch and Python 2.7 from Anaconda.

    Of course the file exist but the data.Generic object which raises the error seems to have an empty ._data attribute. I tried to get more information about that bug but the logs didn't help. It looks like any kind of subfolder produces an error on Windows. Please tell me if there is more information I can provide.

    opened by albop 1
  • stacktrace on  - dexy datas -alias keyvalue

    stacktrace on - dexy datas -alias keyvalue

    dexy datas -alias keyvalue was my best guess of what to do from this

    root@a7c70420830a:~/notebooks/CogU# dexy datas

    bs4 etree generic keyvalue sectioned

    For more information about a particular data type, use the -alias flag and specify the data type alias.


    root@a7c70420830a:~/notebooks/CogU# dexy datas -alias keyvalue

    keyvalue

    Data class for key-value data.

    Methods: append Traceback (most recent call last): File "/opt/conda/envs/python2/bin/dexy", line 9, in load_entry_point('dexy==1.0.14', 'console_scripts', 'dexy')() File "/opt/conda/envs/python2/lib/python2.7/site-packages/dexy/commands/init.py", line 53, in run parse_and_run_cmd(resolve_argv()) File "/opt/conda/envs/python2/lib/python2.7/site-packages/dexy/commands/init.py", line 111, in parse_and_run_cmd args.parse_and_run_command(argv, module, default_command) File "/opt/conda/envs/python2/lib/python2.7/site-packages/modargs/args.py", line 381, in parse_and_run_command command_module(mod, command, options, cli_options=cli_options) File "/opt/conda/envs/python2/lib/python2.7/site-packages/modargs/args.py", line 286, in command_module function(*options) File "/opt/conda/envs/python2/lib/python2.7/site-packages/dexy/commands/env.py", line 96, in datas_command raise dexy.exceptions.InternalDexyProblem("Must provide docstring for %s" % k) dexy.exceptions.InternalDexyProblem: Oops! You may have found a bug in Dexy. The developer would really appreciate if you copy and paste this entire message and the Traceback above it into an email and send to [email protected] Your version of Dexy is 1.0.14 Your platform is Linux Must provide docstring for append

    opened by kbroughton 0
Learn, design or document codebase by putting breadcrumbs in source code. Live updates, multi-language support and more.

What · Demo · Get started · Features · Case studies · Support What Have you ever got lost in a big or unknown codebase? This tool will help you to sol

Bohdan Liashenko 2.6k Jan 3, 2023
YUI Javascript Documentation Tool

YUIDoc YUI's JavaScript Documentation engine. Overview YUIDoc is a Node.js application used at build time to generate API documentation for JavaScript

YUI Library 889 Dec 25, 2022
Tsailun - open source online document and collaboration

Open source selfhosted web-based wiki/doc/knowledge management and collaboration

null 125 Dec 30, 2022
JavaScript documentation generator for node using markdown and jsdoc

Dox Dox is a JavaScript documentation generator written with node. Dox no longer generates an opinionated structure or style for your docs, it simply

TJ Holowaychuk 2.1k Jan 7, 2023
ESDoc - Good Documentation for JavaScript

ESDoc ESDoc is a documentation generator for JavaScript. Please try it out! Features Generates good documentation. Measures documentation coverage. In

ESDoc 2.7k Dec 29, 2022
Main repository for the Sphinx documentation builder

Sphinx Sphinx is a tool that makes it easy to create intelligent and beautiful documentation for Python projects (or other documents consisting of mul

null 5.1k Jan 2, 2023
:book: documentation for modern JavaScript

The documentation system for modern JavaScript ?? Current maintenance status Supports modern JavaScript: ES5, ES2017, JSX, Vue and Flow type annotatio

null 5.6k Jan 4, 2023
Pointers to useful, well-written, and otherwise beautiful documentation.

DO YOU WANT TO BUILD AND WRITE GLORIOUS TECHNICAL DOCUMENTATION FULL TIME? EMAIL [email protected]. WE NEED YOU. Beautiful Docs I love documentation. If

Mark Phillips 7.9k Jan 4, 2023
A collaborative newsroom documentation site, powered by Google Docs.

A collaborative newsroom documentation site, powered by Google Docs.

The New York Times 1k Dec 26, 2022
Adaptation of the popular mkdocs-material material design theme to the sphinx documentation system

Sphinx-Immaterial Theme This theme is an adaptation of the popular mkdocs-material theme for the Sphinx documentation tool. This theme is regularly ma

Jeremy Maitin-Shepard 89 Jan 4, 2023
This is a project that is used to execute python codes in the web page. You can install and use it in django projects, You can do any operations that can be performed in python shell with this package.

Django execute code This is a project that is used to execute python codes in the web page. You can install and use it in django projects, You can do

Shinu 5 Nov 12, 2022
Literate Programming can be Quick and Dirty.

____ /\ _`\ \ \ \/\ \ ___ ___ ___ ___ \ \ \ \ \ / __`\ /'___\ /'___\ / __`\ \ \ \_\ \ /\ \ \

Jeremy Ashkenas 3.5k Dec 31, 2022
Information about the application internals and instructions on how to run it can be found in our Technical Documentation.

Swisstopo Showcases Welcome to our approach on bringing geodata closer to the user. This is our semester project during our Bachelor studies at the Be

Jonas Hofer 3 Sep 30, 2022
The most advanced responsive front-end framework in the world. Quickly create prototypes and production code for sites that work on any kind of device.

Install | Documentation | Releases | Contributing Foundation is the most advanced responsive front-end framework in the world. Quickly go from prototy

Foundation 29.4k Jan 4, 2023
The most advanced responsive front-end framework in the world. Quickly create prototypes and production code for sites that work on any kind of device.

Install | Documentation | Releases | Contributing Foundation is the most advanced responsive front-end framework in the world. Quickly go from prototy

Foundation 29.4k Jan 4, 2023
Grupprojekt för kurserna 'Javascript med Ramverk' och 'Agil Utveckling'

JavaScript-med-Ramverk-Laboration-3 Grupprojektet för kurserna Javascript med Ramverk och Agil Utveckling. Utvecklingsguide För information om hur utv

Svante Jonsson IT-Högskolan 3 May 18, 2022
Hemsida för personer i Sverige som kan och vill erbjuda boende till människor på flykt

Getting Started with Create React App This project was bootstrapped with Create React App. Available Scripts In the project directory, you can run: np

null 4 May 3, 2022
Kurs-repo för kursen Webbserver och Databaser

Webbserver och databaser This repository is meant for CME students to access exercises and codealongs that happen throughout the course. I hope you wi

null 14 Jan 3, 2023
A one-of-a-kind resume builder that keeps your privacy in mind. Completely secure, customizable, portable, open-source and free forever. Try it out today!

A free and open source resume builder. Go to App What is this app all about? Reactive Resume is a free and open source resume builder that’s built to

Reactive Resume 9.7k Jan 3, 2023