38 Commits

Author SHA1 Message Date
Mike McQuaid
be5a7de54a
docs/Python-for-Formula-Authors: fix mdlint
Co-authored-by: Eric Knibbe <enk3@outlook.com>
2024-04-10 08:38:47 +01:00
Michka Popoff
ecc181ccb3
docs: improve, define Python library exception list 2024-04-09 23:14:52 +04:00
Issy Long
ca92fca770
Turn off FormulaAudit/{Desc,Homepage} for docs
- We don't need this blanket enabled, we only have a few docs where it actually matters that there's a description, it's just cruft having to invent descriptions.
2024-02-02 15:37:01 +00:00
Issy Long
aaddc66548
Fix remaining RuboCop FormulaAudit offenses in example code 2024-01-27 12:30:00 +00:00
Issy Long
e5ae67f906
Fix RuboCop FormulaAudit/ group offenses for docs code examples 2024-01-24 00:01:44 +00:00
Mike McQuaid
ae94d9e28b
docs: various tweaks.
Adjust various maintainer and contributor-focused documents after
recent maintainer conversations and generally anything I noticed was
wrong or outdated as I went through these.
2023-12-06 14:29:09 -05:00
Issy Long
1c91da27bb
The Python Setuptools docs have moved around too, the reference no longer exists 2023-09-01 01:02:05 +01:00
Issy Long
3c69671b84
The py2cairo formula was deleted, don't refer to it in docs anymore 2023-09-01 01:02:00 +01:00
Amy Grace
edf022d94e
docs: update formula and cask URLs to new sharded format 2023-08-26 14:54:19 +01:00
EricFromCanada
d615899ca9
Contributors docs: content & formatting updates
Update How-To-Open-a-Homebrew-Pull-Request.md

Update Acceptable-Formulae.md

Update Acceptable-Casks.md

Update License-Guidelines.md

Update Versions.md

Update Versions.md

Update Deprecating-Disabling-and-Removing-Formulae.md

Update Node-for-Formula-Authors.md

Update Python-for-Formula-Authors.md

Update Brew-Livecheck.md

Update Migrating-A-Formula-To-A-Tap.md

Update Rename-A-Formula.md

Update How-to-Create-and-Maintain-a-Tap.md

Update Brew-Test-Bot.md

Update Typechecking.md
2022-11-16 09:03:12 -05:00
Rylan Polster
d06fc3be63 docs: update homebrew-pypi-poet instructions 2021-01-07 13:24:18 -05:00
Rylan Polster
465a1faa8a docs: add reference to update-python-resources 2020-07-31 21:42:20 -04:00
Rylan Polster
111f9e5ca3 docs: update docs to reflect new Python procedures 2020-07-09 14:36:22 -04:00
Mike McQuaid
ac0665daff
Refer to default branch in links with HEAD
Anywhere we can use `blob/master` we can use `blob/HEAD` instead. This
will make life easier if we ever rename our default branch in future
(once/if Git and GitHub provides the necessary tooling to do so).
2020-06-25 11:38:40 +01:00
Michka Popoff
c46a30b575 brew: remove most traces of python@2 2020-02-17 22:38:24 +01:00
Thierry Moisan
111805b03e
Remove --with-python option from an example in the documentation 2020-01-25 10:31:49 -05:00
Mike McQuaid
1aa8ad09e2
Deprecate macOS versions below Mavericks
And remove all dead/unneeded code.
2019-01-27 12:27:47 +00:00
EricFromCanada
31dbc4f985 Various documentation edits
Mostly edits to formatting, grammar, wording for consistency & readability.
2018-10-05 17:23:22 -04:00
Mike McQuaid
54fe8e0ec0
docs: fix broken links. 2018-10-04 15:37:02 +01:00
Viktor Szakats
a0d971a0d0 secure/fix URLs 2018-10-03 21:21:05 +00:00
Anja Kefala
6983a95246
virtualenv_create(libexec, "python") results in error upon install
When the line was switched to the more explicit

`virtualenv_create(libexec, "python3")` the package installed with any issues. 

Arguably, I am not as comfortable as I would like with Homebrew's relationship with Python, so maybe this reveals a larger underlying issue or there was a mistake within the original Formula.

The formula is hosted [here](https://github.com/saulpw/homebrew-vd). 

```
Last 15 lines from /Users/anja/Library/Logs/Homebrew/visidata/14.pip:
  Removing source in /private/tmp/pip-req-build-CH6VRn
visidata requires Python '>=3.4' but the running Python is 2.7.10
Exception information:
Traceback (most recent call last):
  File "/usr/local/Cellar/visidata/1.2/libexec/lib/python2.7/site-packages/pip/_internal/basecommand.py", line 228, in main
    status = self.run(options, args)
  File "/usr/local/Cellar/visidata/1.2/libexec/lib/python2.7/site-packages/pip/_internal/commands/install.py", line 291, in run
    resolver.resolve(requirement_set)
  File "/usr/local/Cellar/visidata/1.2/libexec/lib/python2.7/site-packages/pip/_internal/resolve.py", line 103, in resolve
    self._resolve_one(requirement_set, req)
  File "/usr/local/Cellar/visidata/1.2/libexec/lib/python2.7/site-packages/pip/_internal/resolve.py", line 262, in _resolve_one
    check_dist_requires_python(dist)
  File "/usr/local/Cellar/visidata/1.2/libexec/lib/python2.7/site-packages/pip/_internal/utils/packaging.py", line 55, in check_dist_requires_python
    '.'.join(map(str, sys.version_info[:3])),)
UnsupportedPythonVersion: visidata requires Python '>=3.4' but the running Python is 2.7.10
```
2018-05-29 13:22:16 -04:00
Mike McQuaid
70253f0009 Adjust docs and more internal code for Python 3.
Now we have `python` for Python 3 and `python@2` for Python 2 some more
adjustments need to be made.
2018-03-03 09:42:25 +00:00
Mike McQuaid
2a53c99449
Python-for-Formula-Authors: python from PATH isn't used. 2018-01-12 11:26:11 +00:00
EricFromCanada
762f2fd2d8 docs: remove :python requirement 2018-01-11 20:40:35 -05:00
Alyssa Ross
22a74b69c6
docs: fix audit warning in Python formula example
Auditing a formula with this structure (plus a `desc` statement)
results in an audit warning:

>   * C: 12: col 3: `include` (line 12) should be put before `desc` (line 2)
2018-01-07 17:09:09 +00:00
Mike McQuaid
fab0ea6fda Deprecate Homebrew/homebrew-science 2018-01-01 09:33:43 +00:00
Mike McQuaid
1939952dc4 Remove some hedge words. 2017-08-12 12:59:14 +01:00
Tim D. Smith
a34f1d3a53 Update Python docs
Reflect some of the wisdom learned over the last couple of years, which
contradict some of the earlier dicta.
2017-08-11 22:13:20 -07:00
Alex Semyonov
491bb469e7 Add example links in Python for Formula Authors 2017-07-09 20:25:01 +03:00
Tim D. Smith
1e7bff8081 Remove reference to link_scripts.
Closes #2740.
2017-06-14 22:38:17 -07:00
Michka Popoff
43e38dfc01 Update to venv.pip_install_and_link in doc
`venv.link_scripts(bin) { venv.pip_install buildpath }` is now `venv.pip_install_and_link buildpath`
2017-05-13 23:26:09 +02:00
EricFromCanada
dc7f74210a docs: code example reformatting
Add labeled fences to most code blocks, monospace terms where
appropriate, omit "$" when referring to variables
2017-03-25 22:53:33 -04:00
EricFromCanada
ab4d1a1574 docs: grammar edits, sentence-case secondary headings
Also changes some heading levels so only one primary
heading appears per page.
2017-03-19 14:03:39 -04:00
Viktor Szakats
cc8f029f22 secure urls + remove -k from in-doc curl command 2017-03-14 17:27:11 +00:00
EricFromCanada
ca0071ffc9 Grammar fixes for docs
Fixes to spelling and punctuation for consistency and readability.
2017-02-23 12:20:07 -05:00
EricFromCanada
20bb0aae80 Fix broken or inactive URLs
Bare URLs are auto-linked on GitHub but not on docs.brew.sh, so I added
angle brackets around them where appropriate. Also converted
Markdown-linked URLs for clarity.
2017-02-23 12:09:01 -05:00
Mike McQuaid
127e9def50 Cleanup documentation site
GitHub now nicely generates a documentation site for us at
http://brew.sh/brew based on our docs folder. Optimise the output of
this and the GitHub docs directory for readability and the various user
groupings.
2017-01-04 10:53:21 +00:00
Mike McQuaid
bd6fb88ddc Rearrange repository files. 2016-09-20 10:41:42 +01:00