diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
index 9e29a2ae..bfd86f41 100644
--- a/.github/CODEOWNERS
+++ b/.github/CODEOWNERS
@@ -1 +1,4 @@
-* @iamrecursion @BinarySoftware @joenash
\ No newline at end of file
+* @iamrecursion @BinarySoftware @joenash
+
+# Repo Configuration
+/.github/settings.yml @iamrecursion
diff --git a/.github/settings.yml b/.github/settings.yml
new file mode 100644
index 00000000..05cc6ecb
--- /dev/null
+++ b/.github/settings.yml
@@ -0,0 +1,156 @@
+# See https://github.com/probot/settings for all available settings.
+
+# General Repository Configuration
+repository:
+ name: docs
+ description: A documentation viewer for Enso's in-language documentation.
+ homepage: https://enso.org
+ topics: enso, documentation, viewer
+
+ private: false
+
+ has_issues: true
+ has_wiki: true
+ has_projects: true
+ has_downloads: true
+
+ default_branch: main
+
+ allow_squash_merge: true
+ allow_merge_commit: false
+ allow_rebase_merge: false
+
+# The repository labels configuration
+labels:
+ - name: "Category: Appearance"
+ color: "#d1f0fd"
+ description: The appearance of the viewer
+ - name: "Category: Build"
+ color: "#d1f0fd"
+ description: Build and deployment
+ - name: "Category: Documentation"
+ color: "#d1f0fd"
+ description: Project documentation
+ - name: "Category: Functionality"
+ color: "#d1f0fd"
+ description: The viewer functionality
+
+ - name: "Change: Breaking"
+ color: "#ffdce5"
+ description: A change that will break a public API or user-facing behaviour
+ - name: "Change: Non-Breaking"
+ color: "#ffdce5"
+ description:
+ A change that will not break a public API or user-facing behaviour
+
+ - name: "Difficulty: Beginner"
+ color: "#d1e9c4"
+ description: Little prior knowledge required
+ - name: "Difficulty: Core Contributor"
+ color: "#d1e9c4"
+ description: Should only be attempted by a core contributor
+ - name: "Difficulty: Hard"
+ color: "#d1e9c4"
+ description: Significant prior knowledge required
+ - name: "Difficulty: Intermediate"
+ color: "#d1e9c4"
+ description: Some prior knowledge required
+ - name: "Difficulty: Unknown"
+ color: "#d1e9c4"
+ description: Unable to estimate difficulty
+
+ - name: "Epic"
+ color: "#3E4B9E"
+ description: An epic (should never be assigned manually)
+
+ - name: "Priority: High"
+ color: "#fff1c1"
+ description: Should be completed in the next sprint
+ - name: "Priority: Highest"
+ color: "#fff1c1"
+ description: Should be completed ASAP
+ - name: "Priority: Low"
+ color: "#fff1c1"
+ description: Should be completed in the next three months
+ - name: "Priority: Lowest"
+ color: "#fff1c1"
+ description: Should be completed at some point
+ - name: "Priority: Medium"
+ color: "#fff1c1"
+ description: Should be completed in the next few sprints
+
+ - name: "Size: Small"
+ color: "#ffdfd3"
+ description: Requires a small time commitment
+ - name: "Size: Medium"
+ color: "#ffdfd3"
+ description: Requires a medium time commitment
+ - name: "Size: Large"
+ color: "#ffdfd3"
+ description: Requires a large time commitment
+ - name: "Size: Unknown"
+ color: "#ffdfd3"
+ description: Requires an unknown time commitment
+
+ - name: "Status: Cannot Reproduce"
+ color: "#eeeeee"
+ description: Can't reproduce the issue
+ - name: "Status: Duplicate"
+ color: "#eeeeee"
+ description: A duplicate issue
+ - name: "Status: Good First Issue"
+ color: "#eeeeee"
+ description: A good issue for new contributors
+ - name: "Status: Help Wanted"
+ color: "#eeeeee"
+ description: Help wanted with the task
+ - name: "Status: Info Needed"
+ color: "#eeeeee"
+ description: More information needed from submitter
+ - name: "Status: Invalid"
+ color: "#eeeeee"
+ description: Not valid for some reason
+ - name: "Status: Research Needed"
+ color: "#eeeeee"
+ description: The task will require heavy research to complete
+ - name: "Status: Wontfix"
+ color: "#eeeeee"
+ description: Will not be fixed / not a bug
+
+ - name: "Type: Bug"
+ color: "#ede2fe"
+ description: A bug in Enso
+ - name: "Type: Enhancement"
+ color: "#ede2fe"
+ description: An enhancement to Enso
+ - name: "Type: RFC"
+ color: "#ede2fe"
+ description: An RFC proposing a change to Enso
+
+# Teams configuration
+teams:
+ - name: developers
+ permission: push
+ - name: moderators
+ permission: maintain
+
+# Branch protection
+branches:
+ - name: main
+ protection:
+ required_pull_request_reviews:
+ required_approving_review_count: 1
+ dismiss_stale_reviews: false
+ require_code_owner_reviews: true
+ dismissal_restrictions: {}
+
+ required_status_checks:
+ # Require branches to be up to date before merging.
+ strict: true
+ contexts:
+ - "build"
+ - "check"
+ - "lint"
+ - "license/cla"
+ enforce_admins: null
+ restrictions: null
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
new file mode 100644
index 00000000..8a864add
--- /dev/null
+++ b/.github/workflows/docs.yml
@@ -0,0 +1,22 @@
+name: Docs
+
+on:
+ push:
+ branches: [main]
+ pull_request:
+ branches: [main]
+
+jobs:
+ check:
+ runs-on: ubuntu-latest
+
+ steps:
+ - uses: actions/checkout@v2
+ - name: Install Node
+ uses: actions/setup-node@v1
+ with:
+ node-version: ${{ env.nodeVersion }}
+ - name: Install Prettier
+ run: npm install
+ - name: Check with Prettier
+ run: npx prettier --check .
diff --git a/.github/workflows/python-app.yml b/.github/workflows/python-app.yml
index 647e81e3..785cf02a 100644
--- a/.github/workflows/python-app.yml
+++ b/.github/workflows/python-app.yml
@@ -1,35 +1,48 @@
# This workflow will install Python dependencies, run tests and lint with a single version of Python
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
-name: Python application
+name: Documentation Viewer
on:
push:
- branches: [ main ]
+ branches: [main]
pull_request:
- branches: [ main ]
+ branches: [main]
jobs:
- build:
+ lint:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v2
+ - name: Set up Python 3.9
+ uses: actions/setup-python@v2
+ with:
+ python-version: 3.9
+ - name: Set up Poetry
+ uses: Gr1N/setup-poetry@v4
+ - name: Install dependencies
+ run: poetry install
+ - name: Run black
+ run: poetry run black --check .
+ - name: Run typechecker
+ run: poetry run mypy src --ignore-missing-imports
+ - name: Run linter
+ run: poetry run pylint src
+
+ build:
runs-on: ubuntu-latest
+ needs: lint
steps:
- - uses: actions/checkout@v2
- - name: Set up Python 3.9
- uses: actions/setup-python@v2
- with:
- python-version: 3.9
- - name: Install dependencies
- run: |
- python -m pip install --upgrade pip
- pip install flake8 PyExecJS PyGithub
- - name: Lint with flake8
- run: |
- # stop the build if there are Python syntax errors or undefined names
- flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
- # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
- flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
- - name: Run app
- run: |
- python main.py --token=${{ secrets.GITHUB_TOKEN }}
+ - uses: actions/checkout@v2
+ - name: Set up Python 3.9
+ uses: actions/setup-python@v2
+ with:
+ python-version: 3.9
+ - name: Set up Poetry
+ uses: Gr1N/setup-poetry@v4
+ - name: Install dependencies
+ run: poetry install
+ - name: Run app
+ run: poetry run python src/main.py ${{ secrets.GITHUB_TOKEN }}
diff --git a/.gitignore b/.gitignore
index 051e661d..9bc836a1 100644
--- a/.gitignore
+++ b/.gitignore
@@ -40,6 +40,7 @@ Thumbs.db
###################
.vscode/
distribution/
+gen/
.idea
venv
__pycache__
\ No newline at end of file
diff --git a/.prettierignore b/.prettierignore
new file mode 100644
index 00000000..9d80f84a
--- /dev/null
+++ b/.prettierignore
@@ -0,0 +1,7 @@
+# Build Artifacts
+gen/
+.github/PULL_REQUEST_TEMPLATE.md
+.github/ISSUE_TEMPLATE
+distribution/
+.mypy_cache/
+venv/
diff --git a/.prettierrc.json b/.prettierrc.json
new file mode 100644
index 00000000..a68a6f42
--- /dev/null
+++ b/.prettierrc.json
@@ -0,0 +1,4 @@
+{
+ "printWidth": 80,
+ "proseWrap": "always"
+}
diff --git a/.pylintrc b/.pylintrc
new file mode 100644
index 00000000..75e991c0
--- /dev/null
+++ b/.pylintrc
@@ -0,0 +1,590 @@
+[MASTER]
+
+# A comma-separated list of package or module names from where C extensions may
+# be loaded. Extensions are loading into the active Python interpreter and may
+# run arbitrary code.
+extension-pkg-whitelist=
+
+# Specify a score threshold to be exceeded before program exits with error.
+fail-under=10.0
+
+# Add files or directories to the blacklist. They should be base names, not
+# paths.
+ignore=CVS
+
+# Add files or directories matching the regex patterns to the blacklist. The
+# regex matches against base names, not paths.
+ignore-patterns=
+
+# Python code to execute, usually for sys.path manipulation such as
+# pygtk.require().
+#init-hook=
+
+# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the
+# number of processors available to use.
+jobs=1
+
+# Control the amount of potential inferred values when inferring a single
+# object. This can help the performance when dealing with large functions or
+# complex, nested conditions.
+limit-inference-results=100
+
+# List of plugins (as comma separated values of python module names) to load,
+# usually to register additional checkers.
+load-plugins=
+
+# Pickle collected data for later comparisons.
+persistent=yes
+
+# When enabled, pylint would attempt to guess common misconfiguration and emit
+# user-friendly hints instead of false-positive error messages.
+suggestion-mode=yes
+
+# Allow loading of arbitrary C extensions. Extensions are imported into the
+# active Python interpreter and may run arbitrary code.
+unsafe-load-any-extension=no
+
+
+[MESSAGES CONTROL]
+
+# Only show warnings with the listed confidence levels. Leave empty to show
+# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED.
+confidence=
+
+# Disable the message, report, category or checker with the given id(s). You
+# can either give multiple identifiers separated by comma (,) or put this
+# option multiple times (only on the command line, not in the configuration
+# file where it should appear only once). You can also use "--disable=all" to
+# disable everything first and then reenable specific checks. For example, if
+# you want to run only the similarities checker, you can use "--disable=all
+# --enable=similarities". If you want to run only the classes checker, but have
+# no Warning level messages displayed, use "--disable=all --enable=classes
+# --disable=W".
+disable=print-statement,
+ parameter-unpacking,
+ unpacking-in-except,
+ old-raise-syntax,
+ backtick,
+ long-suffix,
+ old-ne-operator,
+ old-octal-literal,
+ import-star-module-level,
+ non-ascii-bytes-literal,
+ raw-checker-failed,
+ bad-inline-option,
+ locally-disabled,
+ file-ignored,
+ suppressed-message,
+ useless-suppression,
+ deprecated-pragma,
+ use-symbolic-message-instead,
+ apply-builtin,
+ basestring-builtin,
+ buffer-builtin,
+ cmp-builtin,
+ coerce-builtin,
+ execfile-builtin,
+ file-builtin,
+ long-builtin,
+ raw_input-builtin,
+ reduce-builtin,
+ standarderror-builtin,
+ unicode-builtin,
+ xrange-builtin,
+ coerce-method,
+ delslice-method,
+ getslice-method,
+ setslice-method,
+ no-absolute-import,
+ old-division,
+ dict-iter-method,
+ dict-view-method,
+ next-method-called,
+ metaclass-assignment,
+ indexing-exception,
+ raising-string,
+ reload-builtin,
+ oct-method,
+ hex-method,
+ nonzero-method,
+ cmp-method,
+ input-builtin,
+ round-builtin,
+ intern-builtin,
+ unichr-builtin,
+ map-builtin-not-iterating,
+ zip-builtin-not-iterating,
+ range-builtin-not-iterating,
+ filter-builtin-not-iterating,
+ using-cmp-argument,
+ eq-without-hash,
+ div-method,
+ idiv-method,
+ rdiv-method,
+ exception-message-attribute,
+ invalid-str-codec,
+ sys-max-int,
+ bad-python3-import,
+ deprecated-string-function,
+ deprecated-str-translate-call,
+ deprecated-itertools-function,
+ deprecated-types-field,
+ next-method-defined,
+ dict-items-not-iterating,
+ dict-keys-not-iterating,
+ dict-values-not-iterating,
+ deprecated-operator-function,
+ deprecated-urllib-function,
+ xreadlines-attribute,
+ deprecated-sys-function,
+ exception-escape,
+ comprehension-escape,
+ no-member,
+ no-name-in-module
+
+# Enable the message, report, category or checker with the given id(s). You can
+# either give multiple identifier separated by comma (,) or put this option
+# multiple time (only on the command line, not in the configuration file where
+# it should appear only once). See also the "--disable" option for examples.
+enable=c-extension-no-member
+
+
+[REPORTS]
+
+# Python expression which should return a score less than or equal to 10. You
+# have access to the variables 'error', 'warning', 'refactor', and 'convention'
+# which contain the number of messages in each category, as well as 'statement'
+# which is the total number of statements analyzed. This score is used by the
+# global evaluation report (RP0004).
+evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
+
+# Template used to display messages. This is a python new-style format string
+# used to format the message information. See doc for all details.
+#msg-template=
+
+# Set the output format. Available formats are text, parseable, colorized, json
+# and msvs (visual studio). You can also give a reporter class, e.g.
+# mypackage.mymodule.MyReporterClass.
+output-format=text
+
+# Tells whether to display a full report or only the messages.
+reports=no
+
+# Activate the evaluation score.
+score=yes
+
+
+[REFACTORING]
+
+# Maximum number of nested blocks for function / method body
+max-nested-blocks=5
+
+# Complete name of functions that never returns. When checking for
+# inconsistent-return-statements if a never returning function is called then
+# it will be considered as an explicit return statement and no message will be
+# printed.
+never-returning-functions=sys.exit
+
+
+[LOGGING]
+
+# The type of string formatting that logging methods do. `old` means using %
+# formatting, `new` is for `{}` formatting.
+logging-format-style=old
+
+# Logging modules to check that the string format arguments are in logging
+# function parameter format.
+logging-modules=logging
+
+
+[SPELLING]
+
+# Limits count of emitted suggestions for spelling mistakes.
+max-spelling-suggestions=4
+
+# Spelling dictionary name. Available dictionaries: none. To make it work,
+# install the python-enchant package.
+spelling-dict=
+
+# List of comma separated words that should not be checked.
+spelling-ignore-words=
+
+# A path to a file that contains the private dictionary; one word per line.
+spelling-private-dict-file=
+
+# Tells whether to store unknown words to the private dictionary (see the
+# --spelling-private-dict-file option) instead of raising a message.
+spelling-store-unknown-words=no
+
+
+[MISCELLANEOUS]
+
+# List of note tags to take in consideration, separated by a comma.
+notes=FIXME,
+ XXX,
+ TODO
+
+# Regular expression of note tags to take in consideration.
+#notes-rgx=
+
+
+[TYPECHECK]
+
+# List of decorators that produce context managers, such as
+# contextlib.contextmanager. Add to this list to register other decorators that
+# produce valid context managers.
+contextmanager-decorators=contextlib.contextmanager
+
+# List of members which are set dynamically and missed by pylint inference
+# system, and so shouldn't trigger E1101 when accessed. Python regular
+# expressions are accepted.
+generated-members=
+
+# Tells whether missing members accessed in mixin class should be ignored. A
+# mixin class is detected if its name ends with "mixin" (case insensitive).
+ignore-mixin-members=yes
+
+# Tells whether to warn about missing members when the owner of the attribute
+# is inferred to be None.
+ignore-none=yes
+
+# This flag controls whether pylint should warn about no-member and similar
+# checks whenever an opaque object is returned when inferring. The inference
+# can return multiple potential results while evaluating a Python object, but
+# some branches might not be evaluated, which results in partial inference. In
+# that case, it might be useful to still emit no-member and other checks for
+# the rest of the inferred objects.
+ignore-on-opaque-inference=yes
+
+# List of class names for which member attributes should not be checked (useful
+# for classes with dynamically set attributes). This supports the use of
+# qualified names.
+ignored-classes=optparse.Values,thread._local,_thread._local
+
+# List of module names for which member attributes should not be checked
+# (useful for modules/projects where namespaces are manipulated during runtime
+# and thus existing member attributes cannot be deduced by static analysis). It
+# supports qualified module names, as well as Unix pattern matching.
+ignored-modules=
+
+# Show a hint with possible names when a member name was not found. The aspect
+# of finding the hint is based on edit distance.
+missing-member-hint=yes
+
+# The minimum edit distance a name should have in order to be considered a
+# similar match for a missing member name.
+missing-member-hint-distance=1
+
+# The total number of similar names that should be taken in consideration when
+# showing a hint for a missing member.
+missing-member-max-choices=1
+
+# List of decorators that change the signature of a decorated function.
+signature-mutators=
+
+
+[VARIABLES]
+
+# List of additional names supposed to be defined in builtins. Remember that
+# you should avoid defining new builtins when possible.
+additional-builtins=
+
+# Tells whether unused global variables should be treated as a violation.
+allow-global-unused-variables=yes
+
+# List of strings which can identify a callback function by name. A callback
+# name must start or end with one of those strings.
+callbacks=cb_,
+ _cb
+
+# A regular expression matching the name of dummy variables (i.e. expected to
+# not be used).
+dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_
+
+# Argument names that match this expression will be ignored. Default to name
+# with leading underscore.
+ignored-argument-names=_.*|^ignored_|^unused_
+
+# Tells whether we should check for unused import in __init__ files.
+init-import=no
+
+# List of qualified module names which can have objects that can redefine
+# builtins.
+redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io
+
+
+[FORMAT]
+
+# Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
+expected-line-ending-format=
+
+# Regexp for a line that is allowed to be longer than the limit.
+ignore-long-lines=^\s*(# )??$
+
+# Number of spaces of indent required inside a hanging or continued line.
+indent-after-paren=4
+
+# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
+# tab).
+indent-string=' '
+
+# Maximum number of characters on a single line.
+max-line-length=100
+
+# Maximum number of lines in a module.
+max-module-lines=1000
+
+# Allow the body of a class to be on the same line as the declaration if body
+# contains single statement.
+single-line-class-stmt=no
+
+# Allow the body of an if to be on the same line as the test if there is no
+# else.
+single-line-if-stmt=no
+
+
+[SIMILARITIES]
+
+# Ignore comments when computing similarities.
+ignore-comments=yes
+
+# Ignore docstrings when computing similarities.
+ignore-docstrings=yes
+
+# Ignore imports when computing similarities.
+ignore-imports=no
+
+# Minimum lines number of a similarity.
+min-similarity-lines=4
+
+
+[BASIC]
+
+# Naming style matching correct argument names.
+argument-naming-style=snake_case
+
+# Regular expression matching correct argument names. Overrides argument-
+# naming-style.
+#argument-rgx=
+
+# Naming style matching correct attribute names.
+attr-naming-style=snake_case
+
+# Regular expression matching correct attribute names. Overrides attr-naming-
+# style.
+#attr-rgx=
+
+# Bad variable names which should always be refused, separated by a comma.
+bad-names=foo,
+ bar,
+ baz,
+ toto,
+ tutu,
+ tata
+
+# Bad variable names regexes, separated by a comma. If names match any regex,
+# they will always be refused
+bad-names-rgxs=
+
+# Naming style matching correct class attribute names.
+class-attribute-naming-style=any
+
+# Regular expression matching correct class attribute names. Overrides class-
+# attribute-naming-style.
+#class-attribute-rgx=
+
+# Naming style matching correct class names.
+class-naming-style=PascalCase
+
+# Regular expression matching correct class names. Overrides class-naming-
+# style.
+#class-rgx=
+
+# Naming style matching correct constant names.
+const-naming-style=UPPER_CASE
+
+# Regular expression matching correct constant names. Overrides const-naming-
+# style.
+#const-rgx=
+
+# Minimum line length for functions/classes that require docstrings, shorter
+# ones are exempt.
+docstring-min-length=-1
+
+# Naming style matching correct function names.
+function-naming-style=snake_case
+
+# Regular expression matching correct function names. Overrides function-
+# naming-style.
+#function-rgx=
+
+# Good variable names which should always be accepted, separated by a comma.
+good-names=i,
+ j,
+ k,
+ ex,
+ Run,
+ _
+
+# Good variable names regexes, separated by a comma. If names match any regex,
+# they will always be accepted
+good-names-rgxs=
+
+# Include a hint for the correct naming format with invalid-name.
+include-naming-hint=no
+
+# Naming style matching correct inline iteration names.
+inlinevar-naming-style=any
+
+# Regular expression matching correct inline iteration names. Overrides
+# inlinevar-naming-style.
+#inlinevar-rgx=
+
+# Naming style matching correct method names.
+method-naming-style=snake_case
+
+# Regular expression matching correct method names. Overrides method-naming-
+# style.
+#method-rgx=
+
+# Naming style matching correct module names.
+module-naming-style=snake_case
+
+# Regular expression matching correct module names. Overrides module-naming-
+# style.
+#module-rgx=
+
+# Colon-delimited sets of names that determine each other's naming style when
+# the name regexes allow several styles.
+name-group=
+
+# Regular expression which should only match function or class names that do
+# not require a docstring.
+no-docstring-rgx=^_
+
+# List of decorators that produce properties, such as abc.abstractproperty. Add
+# to this list to register other decorators that produce valid properties.
+# These decorators are taken in consideration only for invalid-name.
+property-classes=abc.abstractproperty
+
+# Naming style matching correct variable names.
+variable-naming-style=snake_case
+
+# Regular expression matching correct variable names. Overrides variable-
+# naming-style.
+#variable-rgx=
+
+
+[STRING]
+
+# This flag controls whether inconsistent-quotes generates a warning when the
+# character used as a quote delimiter is used inconsistently within a module.
+check-quote-consistency=no
+
+# This flag controls whether the implicit-str-concat should generate a warning
+# on implicit string concatenation in sequences defined over several lines.
+check-str-concat-over-line-jumps=no
+
+
+[IMPORTS]
+
+# List of modules that can be imported at any level, not just the top level
+# one.
+allow-any-import-level=
+
+# Allow wildcard imports from modules that define __all__.
+allow-wildcard-with-all=no
+
+# Analyse import fallback blocks. This can be used to support both Python 2 and
+# 3 compatible code, which means that the block might have code that exists
+# only in one or another interpreter, leading to false positives when analysed.
+analyse-fallback-blocks=no
+
+# Deprecated modules which should not be used, separated by a comma.
+deprecated-modules=optparse,tkinter.tix
+
+# Create a graph of external dependencies in the given file (report RP0402 must
+# not be disabled).
+ext-import-graph=
+
+# Create a graph of every (i.e. internal and external) dependencies in the
+# given file (report RP0402 must not be disabled).
+import-graph=
+
+# Create a graph of internal dependencies in the given file (report RP0402 must
+# not be disabled).
+int-import-graph=
+
+# Force import order to recognize a module as part of the standard
+# compatibility libraries.
+known-standard-library=
+
+# Force import order to recognize a module as part of a third party library.
+known-third-party=enchant
+
+# Couples of modules and preferred modules, separated by a comma.
+preferred-modules=
+
+
+[CLASSES]
+
+# List of method names used to declare (i.e. assign) instance attributes.
+defining-attr-methods=__init__,
+ __new__,
+ setUp,
+ __post_init__
+
+# List of member names, which should be excluded from the protected access
+# warning.
+exclude-protected=_asdict,
+ _fields,
+ _replace,
+ _source,
+ _make
+
+# List of valid names for the first argument in a class method.
+valid-classmethod-first-arg=cls
+
+# List of valid names for the first argument in a metaclass class method.
+valid-metaclass-classmethod-first-arg=cls
+
+
+[DESIGN]
+
+# Maximum number of arguments for function / method.
+max-args=5
+
+# Maximum number of attributes for a class (see R0902).
+max-attributes=7
+
+# Maximum number of boolean expressions in an if statement (see R0916).
+max-bool-expr=5
+
+# Maximum number of branch for function / method body.
+max-branches=12
+
+# Maximum number of locals for function / method body.
+max-locals=15
+
+# Maximum number of parents for a class (see R0901).
+max-parents=7
+
+# Maximum number of public methods for a class (see R0904).
+max-public-methods=20
+
+# Maximum number of return / yield for function / method body.
+max-returns=6
+
+# Maximum number of statements in function / method body.
+max-statements=50
+
+# Minimum number of public methods for a class (see R0903).
+min-public-methods=2
+
+
+[EXCEPTIONS]
+
+# Exceptions that will emit a warning when being caught. Defaults to
+# "BaseException, Exception".
+overgeneral-exceptions=BaseException,
+ Exception
diff --git a/README.md b/README.md
index ef207bef..d965ffb5 100644
--- a/README.md
+++ b/README.md
@@ -24,7 +24,8 @@
# Enso Standard Library Documentation
This repository contains scripts that generates HTML docs from Enso Std-Lib.
-Documentation is drawn from [here](https://github.com/enso-org/enso/tree/main/distribution/std-lib).
+Documentation is drawn from
+[here](https://github.com/enso-org/enso/tree/main/distribution/std-lib).
### Running
diff --git a/download_helpers.py b/download_helpers.py
deleted file mode 100644
index 0d404429..00000000
--- a/download_helpers.py
+++ /dev/null
@@ -1,62 +0,0 @@
-import os
-import base64
-import shutil
-import requests
-from github import Github
-from github import GithubException
-
-
-def get_sha_for_tag(repository, tag):
- branches = repository.get_branches()
- matched_branches = [match for match in branches if match.name == tag]
- if matched_branches:
- return matched_branches[0].commit.sha
-
- tags = repository.get_tags()
- matched_tags = [match for match in tags if match.name == tag]
- if not matched_tags:
- raise ValueError('No Tag or Branch exists with that name')
- return matched_tags[0].commit.sha
-
-
-def download_directory(repository, sha, server_path):
- if os.path.exists(server_path):
- shutil.rmtree(server_path)
-
- os.makedirs(server_path)
- contents = repository.get_dir_contents(server_path, ref=sha)
-
- for content in contents:
- print("Downloading: %s" % content.path)
- if content.type == 'dir' and not content.path.endswith("THIRD-PARTY"):
- os.makedirs(content.path)
- download_directory(repository, sha, content.path)
- else:
- try:
- path = content.path
- if path.endswith(".enso"):
- file_content = repository.get_contents(path, ref=sha)
- file_data = base64.b64decode(file_content.content)
- file_out = open(content.path, "wb+")
- file_out.write(file_data)
- file_out.close()
- except (GithubException, IOError) as exc:
- print('Error processing %s: %s', content.path, exc)
-
-
-def download_from_git(token: str,
- org: str,
- repo: str,
- branch: str,
- folder: str):
- github = Github(token)
- organization = github.get_organization(org)
- repository = organization.get_repo(repo)
- sha = get_sha_for_tag(repository, branch)
- download_directory(repository, sha, folder)
-
-
-def download_from_url(url, to):
- r = requests.get(url, allow_redirects=True)
- print("Downloading: %s" % url)
- open(to, 'wb').write(r.content)
diff --git a/index.html b/index.html
deleted file mode 100644
index 138f25ac..00000000
--- a/index.html
+++ /dev/null
@@ -1,12 +0,0 @@
-
-
-
-
-
-