Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
P
python-poetry
Overview
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
open
python-poetry
Commits
07e71abb
Commit
07e71abb
authored
Oct 08, 2018
by
Varun Nayyar
Committed by
Sébastien Eustace
Oct 07, 2018
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Fixing relative links in docs (#440)
parent
230f7da7
Show whitespace changes
Inline
Side-by-side
Showing
4 changed files
with
8 additions
and
8 deletions
+8
-8
docs/docs/basic-usage.md
+2
-2
docs/docs/cli.md
+1
-1
docs/docs/configuration.md
+2
-2
docs/docs/libraries.md
+3
-3
No files found.
docs/docs/basic-usage.md
View file @
07e71abb
# Basic usage
For the basic usage introduction we will be installing
`pendulum`
, a datetime library.
If you have not yet installed Poetry, refer to the
[
Introduction
](
/
)
chapter.
If you have not yet installed Poetry, refer to the
[
Introduction
](
/
docs/
)
chapter.
## Project setup
...
...
@@ -69,7 +69,7 @@ It will automatically find a suitable version constraint.
In our example, we are requesting the
`pendulum`
package with the version constraint
`^1.4`
.
This means any version greater or equal to 1.4.0 and less than 2.0.0 (
`>=1.4.0 <2.0.0`
).
Please read
[
versions
](
/versions/
)
for more in-depth information on versions, how versions relate to each other, and on version constraints.
Please read
[
versions
](
/
docs/
versions/
)
for more in-depth information on versions, how versions relate to each other, and on version constraints.
!!!note
...
...
docs/docs/cli.md
View file @
07e71abb
...
...
@@ -278,7 +278,7 @@ poetry config [options] [setting-key] [setting-value1] ... [setting-valueN]
```
`
`
setting-key
` is a configuration option name and `
setting-value1
` is a configuration value.
See [Configuration](/configuration/) for all available settings.
See [Configuration](/
docs/
configuration/) for all available settings.
### Options
...
...
docs/docs/configuration.md
View file @
07e71abb
# Configuration
Poetry can be configured via the
`config`
command (
[
see more about its usage here
](
/cli/#config
)
)
Poetry can be configured via the
`config`
command (
[
see more about its usage here
](
/
docs/
cli/#config
)
)
or directly in the
`config.toml`
file that will be automatically be created when you first run that command.
This file can typically be found in one of the following directories:
...
...
@@ -33,4 +33,4 @@ Defaults to one of the following directories:
### `repositories.<name>`: string
Set a new alternative repository. See
[
Repositories
](
/repositories/
)
for more information.
Set a new alternative repository. See
[
Repositories
](
/
docs/
repositories/
)
for more information.
docs/docs/libraries.md
View file @
07e71abb
...
...
@@ -14,7 +14,7 @@ While Poetry does not enforce any convention regarding package versioning,
it
**strongly**
recommends to follow
[
semantic versioning
](
https://semver.org
)
.
This has many advantages for the end users and allows them to set appropriate
[
version constraints
](
/versions/
)
.
[
version constraints
](
/
docs/
versions/
)
.
## Lock file
...
...
@@ -54,7 +54,7 @@ poetry publish
```
This will package and publish the library to PyPI, at the condition that you are a registered user
and you have
[
configured your credentials
](
/repositories/#adding-credentials
)
properly.
and you have
[
configured your credentials
](
/
docs/
repositories/#adding-credentials
)
properly.
!!!note
...
...
@@ -73,7 +73,7 @@ Sometimes, you may want to keep your library private but also being accessible t
In this case, you will need to use a private repository.
In order to publish to a private repository, you will need to add it to your
global list of repositories. See
[
Adding a repository
](
/repositories/#adding-a-repository
)
global list of repositories. See
[
Adding a repository
](
/
docs/
repositories/#adding-a-repository
)
for more information.
Once this is done, you can actually publish to it like so:
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment