Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Revert "Move "Creating Packages" to Julia docs (#3690)"
Browse files Browse the repository at this point in the history
This reverts commit 7013c10.
KristofferC authored Feb 28, 2024
1 parent 1f16df4 commit 3e8ef41
Showing 10 changed files with 643 additions and 11 deletions.
2 changes: 1 addition & 1 deletion docs/generate.jl
Original file line number Diff line number Diff line change
@@ -29,7 +29,7 @@ end
function generate()
io = IOBuffer()
println(io, """
# [**10.** REPL Mode Reference](@id REPL-Mode-Reference)
# [**11.** REPL Mode Reference](@id REPL-Mode-Reference)
This section describes available commands in the Pkg REPL.
The Pkg REPL mode is mostly meant for interactive use,
1 change: 1 addition & 0 deletions docs/make.jl
Original file line number Diff line number Diff line change
@@ -34,6 +34,7 @@ makedocs(
"getting-started.md",
"managing-packages.md",
"environments.md",
"creating-packages.md",
"compatibility.md",
"registries.md",
"artifacts.md",
2 changes: 1 addition & 1 deletion docs/src/api.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# [**11.** API Reference](@id API-Reference)
# [**12.** API Reference](@id API-Reference)

This section describes the functional API for interacting with Pkg.jl.
It is recommended to use the functional API, rather than the Pkg REPL mode,
2 changes: 1 addition & 1 deletion docs/src/artifacts.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# [**7.** Artifacts](@id Artifacts)
# [**8.** Artifacts](@id Artifacts)

`Pkg` can install and manage containers of data that are not Julia packages. These containers can contain platform-specific binaries, datasets, text, or any other kind of data that would be convenient to place within an immutable, life-cycled datastore.
These containers, (called "Artifacts") can be created locally, hosted anywhere, and automatically downloaded and unpacked upon installation of your Julia package.
2 changes: 0 additions & 2 deletions docs/src/basedocs.md
Original file line number Diff line number Diff line change
@@ -13,8 +13,6 @@ such as installing, updating and removing packages.
version compatibility (`[compat]`), environments, registries, etc.,
it is highly recommended to read the full manual, which is available here:
[https://pkgdocs.julialang.org](https://pkgdocs.julialang.org).
For a tutorial on creating packages, see
[Creating Packages](https://docs.julialang.org/en/v1/tutorials/creating-packages/).

```@eval
import Markdown
2 changes: 1 addition & 1 deletion docs/src/compatibility.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# [**5.** Compatibility](@id Compatibility)
# [**6.** Compatibility](@id Compatibility)

Compatibility refers to the ability to restrict the versions of the dependencies that your project is compatible with.
If the compatibility for a dependency is not given, the project is assumed to be compatible with all versions of that dependency.
633 changes: 633 additions & 0 deletions docs/src/creating-packages.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/src/glossary.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# [**8.** Glossary](@id Glossary)
# [**9.** Glossary](@id Glossary)

**Project:** a source tree with a standard layout, including a `src` directory
for the main body of Julia code, a `test` directory for testing the project,
2 changes: 1 addition & 1 deletion docs/src/registries.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# **6.** Registries
# **7.** Registries

Registries contain information about packages, such as
available releases and dependencies, and where they can be downloaded.
6 changes: 3 additions & 3 deletions docs/src/toml-files.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# [**9.** `Project.toml` and `Manifest.toml`](@id Project-and-Manifest)
# [**10.** `Project.toml` and `Manifest.toml`](@id Project-and-Manifest)

Two files that are central to Pkg are `Project.toml` and `Manifest.toml`. `Project.toml`
and `Manifest.toml` are written in [TOML](https://github.com/toml-lang/toml) (hence the
@@ -39,8 +39,8 @@ name = "Example"
The name must be a valid [identifier](https://docs.julialang.org/en/v1/base/base/#Base.isidentifier)
(a sequence of Unicode characters that does not start with a number and is neither `true` nor `false`).
For packages, it is recommended to follow the
[package naming guidelines](https://docs.julialang.org/en/v1/tutorials/creating-packages/#Package-naming-guidelines).
The `name` field is mandatory for packages.
[package naming guidelines](@ref Package-naming-guidelines). The `name` field is mandatory
for packages.


### The `uuid` field

0 comments on commit 3e8ef41

Please sign in to comment.