Skip to content

Commit

Permalink
Update headings
Browse files Browse the repository at this point in the history
  • Loading branch information
@jacebrowning
jacebrowning committed Oct 31, 2024
1 parent 20f679d commit 4af6cb5
Show file tree
Hide file tree
Showing 4 changed files with 154 additions and 20 deletions.
9 changes: 6 additions & 3 deletions docs/requirements.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ colorama==0.4.5 ; python_version >= "3.8" and python_version < "4.0"
coverage==6.4.4 ; python_version >= "3.8" and python_version < "4.0"
coverage[toml]==6.4.4 ; python_version >= "3.8" and python_version < "4.0"
coveragespace==6.1 ; python_version >= "3.8" and python_version < "4.0"
datafiles==2.2.3 ; python_version >= "3.8" and python_version < "4.0"
datafiles==2.3 ; python_version >= "3.8" and python_version < "4.0"
dill==0.3.8 ; python_version >= "3.8" and python_version < "4.0"
docopt==0.6.2 ; python_version >= "3.8" and python_version < "4.0"
exceptiongroup==1.1.1 ; python_version >= "3.8" and python_version < "3.11"
Expand All @@ -23,14 +23,15 @@ importlib-metadata==4.12.0 ; python_version >= "3.8" and python_version < "4.0"
iniconfig==1.1.1 ; python_version >= "3.8" and python_version < "4.0"
isort==5.13.2 ; python_version >= "3.8" and python_version < "4.0"
jinja2==3.1.4 ; python_version >= "3.8" and python_version < "4.0"
json-five==1.1.2 ; python_version >= "3.8" and python_version < "4.0"
lazy-object-proxy==1.4.3 ; python_version >= "3.8" and python_version < "4.0"
macfsevents==0.8.1 ; python_version >= "3.8" and python_version < "4.0" and sys_platform == "darwin"
macholib==1.16 ; python_version >= "3.8" and python_version < "4.0" and sys_platform == "darwin"
markdown==3.3.7 ; python_version >= "3.8" and python_version < "4.0"
markupsafe==2.1.1 ; python_version >= "3.8" and python_version < "4.0"
mccabe==0.6.1 ; python_version >= "3.8" and python_version < "4.0"
mergedeep==1.3.4 ; python_version >= "3.8" and python_version < "4.0"
minilog==2.3 ; python_version >= "3.8" and python_version < "4.0"
minilog==2.3.1 ; python_version >= "3.8" and python_version < "4.0"
mkdocs-autorefs==0.4.1 ; python_version >= "3.8" and python_version < "4.0"
mkdocs==1.3.1 ; python_version >= "3.8" and python_version < "4.0"
mkdocstrings-python-legacy==0.2.2 ; python_version >= "3.8" and python_version < "4.0"
Expand All @@ -55,19 +56,21 @@ pytest-cov==5.0.0 ; python_version >= "3.8" and python_version < "4.0"
pytest-describe==2.2.0 ; python_version >= "3.8" and python_version < "4.0"
pytest-expecter==3.0 ; python_version >= "3.8" and python_version < "4.0"
pytest-random==0.02 ; python_version >= "3.8" and python_version < "4.0"
pytest==8.1.2 ; python_version >= "3.8" and python_version < "4.0"
pytest==8.3.2 ; python_version >= "3.8" and python_version < "4.0"
python-dateutil==2.8.2 ; python_version >= "3.8" and python_version < "4.0"
python-termstyle==0.1.10 ; python_version >= "3.8" and python_version < "4.0"
pytkdocs==0.16.1 ; python_version >= "3.8" and python_version < "4.0"
pywin32-ctypes==0.2.0 ; python_version >= "3.8" and python_version < "4.0" and sys_platform == "win32"
pyyaml-env-tag==0.1 ; python_version >= "3.8" and python_version < "4.0"
pyyaml==6.0.1 ; python_version >= "3.8" and python_version < "4.0"
regex==2024.9.11 ; python_version >= "3.8" and python_version < "4.0"
requests==2.32.2 ; python_version >= "3.8" and python_version < "4.0"
rope==0.14.0 ; python_version >= "3.8" and python_version < "4.0"
ruamel-yaml-clib==0.2.8 ; platform_python_implementation == "CPython" and python_version < "3.11" and python_version >= "3.8"
ruamel-yaml==0.17.21 ; python_version >= "3.8" and python_version < "4.0"
setuptools==70.0.0 ; python_version >= "3.8" and python_version < "4.0"
six==1.16.0 ; python_version >= "3.8" and python_version < "4.0"
sly==0.5 ; python_version >= "3.8" and python_version < "4.0"
sniffer==0.4.1 ; python_version >= "3.8" and python_version < "4.0"
snowballstemmer==2.2.0 ; python_version >= "3.8" and python_version < "4.0"
tomli==2.0.1 ; python_version >= "3.8" and python_full_version <= "3.11.0a6"
Expand Down
15 changes: 8 additions & 7 deletions docs/setup/git.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,18 +50,19 @@ $ git clone https://<token>@github.com/<owner>/<repo>.git

The token can also be written to `.netrc` during builds, see the guide for [Travis CI](https://docs.travis-ci.com/user/private-dependencies/#API-Token).

## Symlinks in Git Repositories under Windows
## Symlinks on Windows

If you're using Windows, there are some additional prerequisites to ensure Gitman works seamlessly.
If you're using Windows, there are some additional prerequisites to ensure Gitman works seamlessly with symbolic links.

### Permission to create Symlinks
### Grant Permissions

For Gitman to link your dependencies to your project, your Windows user account needs permission to create symlinks. By default, this permission may not be granted. To enable it, you can:
* Assign your user account the **"Create symbolic links"** permission in the Local Group Policy Editor.
* Enable **"Developer Mode"** in the Windows Settings.

* Assign your user account the **Create symbolic links** permission in the Local Group Policy Editor.
* Enable **Developer Mode** in the Windows Settings.
* Run the command-line interface as an **Administrator**.

### Configure Git to Handle Symlinks Correctly
### Configure Git

In Git for Windows, symlink support must be enabled. You can do this during the installation process (checkbox in the install wizard) or by configuring it manually with the following command:

Expand All @@ -85,4 +86,4 @@ touch .git/info/exclude
git ls-files -o --exclude-standard > /tmp/unstaged_files
cat /tmp/unstaged_files >> .git/info/exclude
rm /tmp/unstaged_files
```
```
Loading

0 comments on commit 4af6cb5

Please sign in to comment.