Exclude modules from docs (#2218)

Closes #2216.
This commit is contained in:
José Valim 2023-09-21 12:28:45 +02:00 committed by GitHub
parent 4d76c57530
commit 64dad900d7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
118 changed files with 4 additions and 237 deletions

View file

@ -1,5 +1,4 @@
defmodule LivebookSpace.Application do
@moduledoc false
use Application

View file

@ -1,8 +1,6 @@
defmodule Livebook do
@moduledoc """
Livebook is an interactive notebook system for Elixir.
This module includes the public API.
This module provides a public Elixir API for integrating with Livebook.
## Configuration

View file

@ -1,6 +1,4 @@
defmodule Livebook.App do
@moduledoc false
# Process corresponding to a deployed app, orchestrating app sessions.
#
# An app process is identified by a user-defined slug, which also

View file

@ -1,6 +1,4 @@
defmodule Livebook.Application do
@moduledoc false
use Application
def start(_type, _args) do

View file

@ -1,6 +1,4 @@
defmodule Livebook.Apps do
@moduledoc false
# This module is responsible for starting and discovering apps.
#
# App processes are tracked using `Livebook.Tracker` in the same way

View file

@ -1,6 +1,4 @@
defmodule Livebook.Config do
@moduledoc false
alias Livebook.FileSystem
@type auth_mode() :: :token | :password | :disabled

View file

@ -1,6 +1,4 @@
defmodule Livebook.Delta do
@moduledoc false
# Delta is a format used to represent a set of changes introduced
# to a text document.
#

View file

@ -1,6 +1,4 @@
defmodule Livebook.Delta.Operation do
@moduledoc false
# An operation represents an atomic change applicable to a text.
#
# For plain-text (our use case) an operation can be either of:

View file

@ -1,6 +1,4 @@
defmodule Livebook.Delta.Transformation do
@moduledoc false
# Implementation of the Operational Transformation algorithm for
# deltas.
#

View file

@ -1,6 +1,4 @@
defmodule Livebook.EctoTypes.HexColor do
@moduledoc false
use Ecto.Type
@impl true

View file

@ -1,6 +1,4 @@
defprotocol Livebook.FileSystem do
@moduledoc false
# This protocol defines an interface for a virtual file system that
# can be plugged into Livebook.

View file

@ -1,6 +1,4 @@
defmodule Livebook.FileSystem.File do
@moduledoc false
# A file points to a specific location in the given file system.
#
# This module provides a number of high-level functions similar to

View file

@ -1,6 +1,4 @@
defmodule Livebook.FileSystem.Local do
@moduledoc false
# File system backed by local disk.
defstruct [:origin_pid, :default_path, id: "local"]

View file

@ -1,5 +1,4 @@
defmodule Livebook.FileSystem.S3 do
@moduledoc false
use Ecto.Schema
import Ecto.Changeset

View file

@ -1,6 +1,4 @@
defmodule Livebook.FileSystem.S3.Client do
@moduledoc false
alias Livebook.FileSystem
alias Livebook.FileSystem.S3

View file

@ -1,6 +1,4 @@
defmodule Livebook.FileSystem.S3.XML do
@moduledoc false
# Adapted from https://github.com/aws-beam/aws-elixir/blob/v0.8.0/lib/aws/xml.ex
import Record

View file

@ -1,6 +1,4 @@
defmodule Livebook.FileSystem.Utils do
@moduledoc false
alias Livebook.FileSystem
@doc """

View file

@ -1,6 +1,4 @@
defmodule Livebook.FileSystems do
@moduledoc false
alias Livebook.FileSystem
@doc """

View file

@ -1,6 +1,4 @@
defmodule Livebook.Hubs do
@moduledoc false
alias Livebook.FileSystem
alias Livebook.Storage
alias Livebook.Hubs.{Broadcasts, Metadata, Personal, Provider, Team}

View file

@ -1,6 +1,4 @@
defmodule Livebook.Hubs.Broadcasts do
@moduledoc false
alias Livebook.FileSystem
alias Livebook.Secrets.Secret

View file

@ -1,6 +1,4 @@
defmodule Livebook.Hubs.Metadata do
@moduledoc false
defstruct [:id, :name, :provider, :emoji, connected?: false]
@type t :: %__MODULE__{

View file

@ -1,6 +1,4 @@
defmodule Livebook.Hubs.Personal do
@moduledoc false
use Ecto.Schema
import Ecto.Changeset

View file

@ -1,6 +1,4 @@
defprotocol Livebook.Hubs.Provider do
@moduledoc false
alias Livebook.FileSystem
alias Livebook.Secrets.Secret

View file

@ -1,11 +1,8 @@
defmodule Livebook.Hubs.Team do
@moduledoc false
use Ecto.Schema
import Ecto.Changeset
defmodule Offline do
@moduledoc false
use Ecto.Schema
alias Livebook.Secrets.Secret

View file

@ -1,5 +1,4 @@
defmodule Livebook.Hubs.TeamClient do
@moduledoc false
use GenServer
require Logger

View file

@ -1,6 +1,4 @@
defmodule Livebook.Intellisense do
@moduledoc false
# This module provides intellisense related operations suitable for
# integration with a text editor.
#

View file

@ -1,6 +1,4 @@
defmodule Livebook.Intellisense.Docs do
@moduledoc false
# This module is responsible for extracting and normalizing
# information like documentation, signatures and specs.

View file

@ -1,6 +1,4 @@
defmodule Livebook.Intellisense.IdentifierMatcher do
@moduledoc false
# This module allows for extracting information about identifiers
# based on code and runtime information (binding, environment).
#

View file

@ -1,6 +1,4 @@
defmodule Livebook.Intellisense.SignatureMatcher do
@moduledoc false
# This module allows for extracting information about function
# signatures matching an incomplete call.

View file

@ -1,6 +1,4 @@
defmodule Livebook.JSInterop do
@moduledoc false
alias Livebook.Delta
@doc """

View file

@ -1,6 +1,4 @@
defmodule Livebook.LiveMarkdown do
@moduledoc false
# File format used to store Livebook notebooks.
#
# The format is a subset of Markdown, which means that every Live

View file

@ -1,6 +1,4 @@
defmodule Livebook.LiveMarkdown.MarkdownHelpers do
@moduledoc false
@doc """
Wraps `EarmarkParser.as_ast/2`.
"""

View file

@ -1,6 +1,4 @@
defmodule Livebook.Migration do
@moduledoc false
@doc """
Runs all migrations.
"""

View file

@ -1,6 +1,4 @@
defmodule Livebook.Notebook do
@moduledoc false
# Data structure representing a notebook.
#
# A notebook is just a document and roughly maps to a plain file

View file

@ -1,6 +1,4 @@
defmodule Livebook.Notebook.AppSettings do
@moduledoc false
# Data structure configuring how notebook gets deployed as an app.
use Ecto.Schema

View file

@ -1,6 +1,4 @@
defmodule Livebook.Notebook.Cell do
@moduledoc false
# Data structure representing a single cell in a notebook.
#
# Cell is the smallest structural unit in a notebook, in other words

View file

@ -1,6 +1,4 @@
defmodule Livebook.Notebook.Cell.Code do
@moduledoc false
# Notebook cell with evaluable code.
#
# It consists of text content that the user can edit and produces

View file

@ -1,6 +1,4 @@
defmodule Livebook.Notebook.Cell.Markdown do
@moduledoc false
# Notebook cell with Markdown text content.
#
# It consists of text content that the user can edit and which is

View file

@ -1,6 +1,4 @@
defmodule Livebook.Notebook.Cell.Smart do
@moduledoc false
# A cell with evaluable code that is edited through a dedicated UI.
#
# Smart cell is supposed to provide the user with an easy, code-free

View file

@ -1,6 +1,4 @@
defmodule Livebook.Notebook.ContentLoader do
@moduledoc false
alias Livebook.Utils.HTTP
@typedoc """

View file

@ -1,9 +1,5 @@
defmodule Livebook.Notebook.Learn do
@moduledoc false
defmodule NotFoundError do
@moduledoc false
defexception [:slug, plug_status: 404]
def message(%{slug: slug}) do

View file

@ -1,6 +1,4 @@
defmodule Livebook.Notebook.Section do
@moduledoc false
# Data structure representing a single section in a notebook.
#
# Section can contains a number of cells and serves as a way of

View file

@ -1,6 +1,4 @@
defmodule Livebook.NotebookManager do
@moduledoc false
use GenServer
alias Livebook.Storage

View file

@ -1,6 +1,4 @@
defmodule Livebook.Release do
@moduledoc false
@doc """
Runs the setup for all apps deployed from directory on startup.
"""

View file

@ -1,6 +1,4 @@
defprotocol Livebook.Runtime do
@moduledoc false
# This protocol defines an interface for code evaluation backends.
#
# Usually a runtime involves a set of processes responsible for

View file

@ -1,6 +1,4 @@
defmodule Livebook.Runtime.Attached do
@moduledoc false
# A runtime backed by an Elixir node managed externally.
#
# Such node must be already started and available, Livebook doesn't

View file

@ -1,6 +1,4 @@
defmodule Livebook.Runtime.Definitions do
@moduledoc false
kino = %{
name: "kino",
dependency: %{dep: {:kino, github: "livebook-dev/kino", override: true}, config: []}

View file

@ -1,6 +1,4 @@
defmodule Livebook.Runtime.Dependencies do
@moduledoc false
@doc """
Adds the given list of dependencies to the setup code.
"""

View file

@ -1,6 +1,4 @@
defmodule Livebook.Runtime.Embedded do
@moduledoc false
# A runtime backed by the same node Livebook is running in.
#
# This runtime is reserved for specific use cases, where there is

View file

@ -1,6 +1,4 @@
defmodule Livebook.Runtime.ErlDist do
@moduledoc false
# This module allows for initializing connected runtime nodes with
# modules and processes necessary for evaluation.
#

View file

@ -1,6 +1,4 @@
defmodule Livebook.Runtime.ErlDist.EvaluatorSupervisor do
@moduledoc false
# Supervisor responsible for dynamically spawning
# and terminating evaluator server processes.

View file

@ -1,6 +1,4 @@
defmodule Livebook.Runtime.ErlDist.IOForwardGL do
@moduledoc false
# An IO device process forwarding all requests to sender's group
# leader.
#

View file

@ -1,6 +1,4 @@
defmodule Livebook.Runtime.ErlDist.LoggerGLBackend do
@moduledoc false
# A logger backend used to forward logs to Livebook,
# as with regular output.
#

View file

@ -1,6 +1,4 @@
defmodule Livebook.Runtime.ErlDist.LoggerGLHandler do
@moduledoc false
@doc false
def log(%{meta: meta} = event, %{formatter: {formatter_module, formatter_config}}) do
message = apply(formatter_module, :format, [event, formatter_config])

View file

@ -1,6 +1,4 @@
defmodule Livebook.Runtime.ErlDist.NodeManager do
@moduledoc false
# The primary Livebook process started on a remote node.
#
# This process is responsible for initializing the node with necessary

View file

@ -1,6 +1,4 @@
defmodule Livebook.Runtime.ErlDist.RuntimeServer do
@moduledoc false
# A server process backing a specific runtime.
#
# This process handles `Livebook.Runtime` operations,

View file

@ -1,6 +1,4 @@
defmodule Livebook.Runtime.ErlDist.Sink do
@moduledoc false
# An idle process that ignores all incoming messages.
use GenServer

View file

@ -1,6 +1,4 @@
defmodule Livebook.Runtime.ErlDist.SmartCellGL do
@moduledoc false
use GenServer
@spec start_link(pid()) :: GenServer.on_start()

View file

@ -1,6 +1,4 @@
defmodule Livebook.Runtime.Evaluator do
@moduledoc false
# A process responsible for evaluating notebook code.
#
# When evaluator receives an evaluation request, it synchronously

View file

@ -1,6 +1,4 @@
defmodule Livebook.Runtime.Evaluator.Doctests do
@moduledoc false
@test_timeout 5_000
@line_width 80
@pad_size 3

View file

@ -1,6 +1,4 @@
defmodule Livebook.Runtime.Evaluator.Formatter do
@moduledoc false
require Logger
@doc """

View file

@ -1,6 +1,4 @@
defmodule Livebook.Runtime.Evaluator.IOProxy do
@moduledoc false
# An IO device process used by `Evaluator` as the group leader.
#
# The process implements [the Erlang I/O Protocol](https://erlang.org/doc/apps/stdlib/io_protocol.html)

View file

@ -1,6 +1,4 @@
defmodule Livebook.Runtime.Evaluator.ObjectTracker do
@moduledoc false
# This module is an abstraction for tracking objects,
# references to them and garbage collection.
#

View file

@ -1,6 +1,4 @@
defmodule Livebook.Runtime.Evaluator.Tracer do
@moduledoc false
# Compilation tracer used by the evaluator.
#
# Events are pre-processed and sent to the group leader, where the

View file

@ -1,8 +1,6 @@
defmodule Livebook.Runtime.NodePool do
use GenServer
@moduledoc false
# A pool with generated node names.
#
# The names are randomly generated, however to avoid atom exhaustion

View file

@ -1,6 +1,4 @@
defmodule Livebook.Runtime.StandaloneInit do
@moduledoc false
# Generic functionality related to starting and setting up
# a new Elixir system process. It's used by ElixirStandalone.

View file

@ -1,6 +1,5 @@
defmodule Livebook.Secrets do
# Shared secret functionality across all hubs.
@moduledoc false
alias Livebook.Secrets.Secret

View file

@ -1,5 +1,4 @@
defmodule Livebook.Secrets.Secret do
@moduledoc false
use Ecto.Schema
import Ecto.Changeset

View file

@ -1,6 +1,4 @@
defmodule Livebook.Session do
@moduledoc false
# Server process representing a single notebook session.
#
# Session keeps a notebook document, as well as additional ephemeral

View file

@ -1,6 +1,4 @@
defmodule Livebook.Session.Data do
@moduledoc false
# Session data is a state shared across all of the clients.
#
# In practice this structure is a `Notebook` decorated with all the

View file

@ -1,6 +1,4 @@
defmodule Livebook.Session.FileGuard do
@moduledoc false
# Serves as a locking mechanism for notebook files.
#
# Every session process willing to persist notebook

View file

@ -1,6 +1,4 @@
defmodule Livebook.Session.Worker do
@moduledoc false
# A dedicated process for offloading the session process,
# when the session state is not necessary.
#

View file

@ -1,6 +1,4 @@
defmodule Livebook.Sessions do
@moduledoc false
# This module is responsible for starting and discovering sessions.
#
# Every session has a server process and is described by a `%Session{}`

View file

@ -1,6 +1,4 @@
defmodule Livebook.Settings do
@moduledoc false
# Keeps all Livebook settings that are backed by storage.
import Ecto.Changeset, only: [apply_action: 2]

View file

@ -1,5 +1,4 @@
defmodule Livebook.Settings.EnvVar do
@moduledoc false
use Ecto.Schema
import Ecto.Changeset

View file

@ -1,6 +1,4 @@
defmodule Livebook.Stamping do
@moduledoc false
# Cryptographic functions used to implement notebook stamping.
@doc """

View file

@ -1,6 +1,4 @@
defmodule Livebook.Storage do
@moduledoc false
# Storage for arbitrary data in [Entity-Attribute-Value](https://en.wikipedia.org/wiki/Entity%E2%80%93attribute%E2%80%93value_model)
# fashion.
#
@ -22,8 +20,6 @@ defmodule Livebook.Storage do
@type entity :: %{required(:id) => entity_id(), optional(attribute()) => value()}
defmodule NotFoundError do
@moduledoc false
defexception [:id, :namespace, plug_status: 404]
def message(%{namespace: namespace, id: id}) do

View file

@ -1,6 +1,4 @@
defmodule Livebook.SystemResources do
@moduledoc false
# Periodically computes system resource usage.
@type memory :: %{total: non_neg_integer(), free: non_neg_integer()}

View file

@ -1,6 +1,4 @@
defmodule Livebook.Teams do
@moduledoc false
alias Livebook.{FileSystem, Hubs}
alias Livebook.Hubs.Team
alias Livebook.Secrets.Secret

View file

@ -1,6 +1,4 @@
defmodule Livebook.Teams.Connection do
@moduledoc false
@behaviour :gen_statem
require Logger

View file

@ -1,6 +1,4 @@
defmodule Livebook.Teams.Org do
@moduledoc false
use Ecto.Schema
import Ecto.Changeset

View file

@ -1,6 +1,4 @@
defmodule Livebook.Teams.Requests do
@moduledoc false
alias Livebook.FileSystem
alias Livebook.FileSystems
alias Livebook.Hubs.Team

View file

@ -1,6 +1,4 @@
defmodule Livebook.Teams.WebSocket do
@moduledoc false
alias Mint.WebSocket.UpgradeFailureError
@ws_path "/user/websocket"

View file

@ -1,6 +1,4 @@
defmodule Livebook.Tracker do
@moduledoc false
use Phoenix.Tracker
alias Livebook.Session

View file

@ -1,6 +1,4 @@
defmodule Livebook.UpdateCheck do
@moduledoc false
# Periodically checks for available Livebook update.
use GenServer

View file

@ -1,6 +1,4 @@
defmodule Livebook.Users do
@moduledoc false
alias Livebook.Users.User
@doc """

View file

@ -1,6 +1,4 @@
defmodule Livebook.Users.User do
@moduledoc false
# Represents a Livebook user.
#
# Livebook users are not regular web app accounts,

View file

@ -1,6 +1,4 @@
defmodule Livebook.Utils do
@moduledoc false
require Logger
@type id :: binary()

View file

@ -1,6 +1,4 @@
defmodule Livebook.Utils.ANSI do
@moduledoc false
@type modifiers :: list(modifier())
@type modifier ::

View file

@ -1,6 +1,4 @@
defmodule Livebook.Utils.Graph do
@moduledoc false
@typedoc """
A bottom-up graph representation encoded as a map of child-to-parent
entries.

View file

@ -1,6 +1,4 @@
defmodule Livebook.Utils.HTTP do
@moduledoc false
@type status :: non_neg_integer()
@type headers :: list(header())
@type header :: {String.t(), String.t()}

View file

@ -1,6 +1,4 @@
defmodule Livebook.Utils.Time do
@moduledoc false
# A simplified version of https://gist.github.com/tlemens/88e9b08f62150ba6082f478a4a03ac52
@doc """

View file

@ -1,6 +1,4 @@
defmodule Livebook.Utils.UniqueTask.Task do
@moduledoc false
use GenServer, restart: :temporary
@registry Livebook.Utils.UniqueTask.Registry
@ -22,8 +20,6 @@ defmodule Livebook.Utils.UniqueTask.Task do
end
defmodule Livebook.Utils.UniqueTask do
@moduledoc false
use Supervisor
@registry Livebook.Utils.UniqueTask.Registry

View file

@ -1,6 +1,4 @@
defmodule LivebookCLI do
@moduledoc false
def usage() do
"""
Usage: livebook [command] [options]

View file

@ -1,6 +1,4 @@
defmodule LivebookCLI.Server do
@moduledoc false
@behaviour LivebookCLI.Task
@external_resource "README.md"

View file

@ -1,6 +1,4 @@
defmodule LivebookCLI.Task do
@moduledoc false
@doc """
Returns a description of the task usage.
"""

View file

@ -1,6 +1,4 @@
defmodule LivebookWeb do
@moduledoc false
def static_paths, do: ~w(assets images favicon.svg favicon.png robots.txt)
def controller do

View file

@ -1,4 +1,3 @@
defmodule LivebookWeb.NotFoundError do
@moduledoc false
defexception [:message, plug_status: 404]
end

View file

@ -1,6 +1,4 @@
defmodule LivebookWeb.Helpers.ANSI do
@moduledoc false
@doc """
Takes a string with ANSI escape codes and build a HTML safe string
with `span` tags having classes corresponding to the escape codes.

View file

@ -1,6 +1,4 @@
defmodule LivebookWeb.FileSystemWriter do
@moduledoc false
# Custom writer for live uploads, uploading directly using the
# `Livebook.FileSystem` abstraction.
#

Some files were not shown because too many files have changed in this diff Show more