Jordan Sissel
08dc21b8f1
Version bump and generate docs
2024-12-08 23:22:18 -08:00
David Newhall II
bf0aa55655
build proper freebsd package
2024-08-08 06:07:24 -07:00
Brad Pitcher
86be3cc802
fix the link to ruby installation instructions
2024-04-11 08:06:02 -06:00
Natanael Arndt
847ded9eba
Update dir.rst
...
Fix formatting for `--prefix`
2024-01-02 07:08:01 -08:00
Jordan Sissel
18233c334d
Version bump 1.15.1
2023-01-31 19:49:10 -08:00
Jordan Sissel
10c8471179
Change docs tooling to use podman instead of docker
2022-11-13 23:24:21 -08:00
Jordan Sissel
42f2660a58
Regenerate docs with new flag sorting method.
2022-11-13 23:07:42 -08:00
Jordan Sissel
d8bc03a63c
Try to more-reliably sort options by name
...
New feature here is that --foo and --[no-]foo are both sorted as "foo",
so flags should be reasonably grouped together now.
2022-11-13 23:07:42 -08:00
Jordan Sissel
15aaf1cfce
Add LOAD_PATH flag for cli generator
2022-11-13 23:07:42 -08:00
Jordan Sissel
601cfda057
Update changelog
2022-11-13 23:07:42 -08:00
Jordan Sissel
82284c7a4b
Rerun `make release-prep`
2022-03-31 00:15:23 -07:00
Jordan Sissel
2943d82581
Version bump and update changelog
2022-03-31 00:09:25 -07:00
Jordan Sissel
521d030420
Fix reStructuredText header length syntax
2022-03-30 23:15:59 -07:00
Jordan Sissel
106828fc12
Add description in header
2022-03-30 23:15:59 -07:00
Jordan Sissel
0c84173de0
Add description in header
2022-03-30 23:15:59 -07:00
Jordan Sissel
9b9a1b365f
Add very basic package docs for each type of package.
...
Thanks to @alanc and _msw_ for quickly helping me figure out good words
to write to describe Solaris' p5p format.
For #1884 .
2022-03-30 23:15:59 -07:00
Geoff Beier
7a1302d1e8
fix typo in "perl"
2022-01-26 12:22:04 -08:00
Jordan Sissel
20e754adfb
Update changelog after #1854 was fixed.
2021-11-10 15:01:04 -08:00
Jordan Sissel
bba3114075
Regenerate in prep for release
2021-11-09 22:29:16 -08:00
Jordan Sissel
23c5790ec4
Update version in docs. Also fix link
2021-11-09 22:28:04 -08:00
Jordan Sissel
d5985a5571
Fix sphinx error about empty block.
2021-11-09 22:27:50 -08:00
Jordan Sissel
f722c4b3f5
Add introduction for the landing page.
2021-11-09 22:27:24 -08:00
seph
62f1418e4a
Add documentation for running fpm from docker
...
Also add documentation for running the fpm test suite in docker.
From #1681
2021-11-09 16:47:02 -08:00
Jordan Sissel
58ddeda91b
Apply fix for readthedocs building errors.
...
https://blog.readthedocs.com/build-errors-docutils-0-18/
For #1848
Hoping this fixes it. Readthedocs emails me whenever doc build fails, and
for the past week or two, it has said the following:
```
Running Sphinx v1.8.5
loading translations [en]... done
making output directory...
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 37 source files that are out of date
updating environment: 37 added, 0 changed, 0 removed
reading sources... [ 2%] changelog
reading sources... [ 5%] changelog_links
reading sources... [ 8%] cli-reference
Traceback (most recent call last):
File "/home/docs/checkouts/readthedocs.org/user_builds/fpm/envs/latest/lib/python2.7/site-packages/sphinx/cmd/build.py", line 304, in build_main
app.build(args.force_all, filenames)
[ ... cut for brevity ... ]
File "/home/docs/checkouts/readthedocs.org/user_builds/fpm/envs/latest/lib/python2.7/site-packages/sphinx/util/nodes.py", line 94, in apply_source_workaround
for classifier in reversed(node.parent.traverse(nodes.classifier)):
TypeError: argument to reversed() must be a sequence
```
2021-11-09 15:52:31 -08:00
Jordan Sissel
11646b943f
Add cpan docs per #1838
2021-11-09 15:44:37 -08:00
Jordan Sissel
c6baaf9427
Fix formatting typo. Needed '::' to make the next paragraph pre-formatted code
2021-11-09 15:44:37 -08:00
Jordan Sissel
9efd56c54a
Add npm/nodejs package documentation
...
This example uses the `ascii-art` npm package. I have realized that
using this package with its example ascii art is likely not accessible
for screen readers. I'll keep the example for now and revise it later.
2021-11-09 15:44:37 -08:00
Jordan Sissel
3540cfeb4b
Add `dir` docs
...
For #1838
2021-11-09 15:44:37 -08:00
Jordan Sissel
cb24061992
Fix formatting and rpm examples.
2021-11-09 15:44:37 -08:00
Jordan Sissel
d6a77bff2a
Add docs for 'empty' package type
2021-11-09 15:44:37 -08:00
Jordan Sissel
e8fb21d725
Move generated cli docs to packages/cli/{type}.rst
...
I'm hoping this makes it easier to find files in the docs/packages
directory.
2021-11-09 15:44:37 -08:00
Jordan Sissel
aecf23801d
Add 'make view' in the docs/Makefile. Live-reloading sphinx html build.
...
Use sphinx-autobuild to run a server which autobuilds and reloads docs
in the browser.
2021-11-09 15:44:37 -08:00
Jordan Sissel
c83461caf7
Add Debian package docs.
...
For #1838
2021-11-09 15:44:37 -08:00
Jordan Sissel
285c13554f
Generate per-package-type command line docs
...
Add it to the rpm example.
Added make target in docs/ 'package-type-cli' to generate all the cli
docs pages.
2021-11-09 15:44:37 -08:00
Jordan Sissel
5bd26ad011
Add packaging types doc page
2021-11-09 15:44:37 -08:00
Jordan Sissel
2ccf61c01f
Generate reStructuredText documentation for command-line flags.
2021-08-15 23:05:34 -07:00
Vedant K
720e140d78
docs: fix case in command output
2021-08-15 21:57:40 -07:00
Vedant K
cdf110d730
docs: remove fpm runtime deps (ruby, ffi, etc) from optional deps section
2021-08-15 21:57:40 -07:00
Vedant K
2834bb5816
docs: add link to issue #54 (rpm build dependency removal)
2021-08-15 21:57:40 -07:00
Vedant K
9fd97d747c
docs: add -s flag to .fpm in getting started guide
2021-08-15 21:57:40 -07:00
Vedant K
37525ca4b0
docs: fix typo
2021-08-15 21:57:40 -07:00
Vedant K
3bb5e99f2a
docs: add note about cli flags overriding .fpm file
2021-08-15 21:57:40 -07:00
Vedant K
99c5fcb485
rewrite some parts of documentation
2021-08-15 21:57:40 -07:00
Jordan Sissel
01b67d747f
Version bump
2021-07-06 14:31:42 -07:00
allen joslin
dbd8bafb5d
Update installing.rst
...
add 'brew install rpm' as a prerequisite in the OSX/macOS section
2021-06-24 16:51:13 -07:00
Jordan Sissel
e96dc2729a
Version bump
2021-06-19 00:50:47 -07:00
Zoe O'Connell
d69ed14bd8
dir.rst: First example also requires trailing slash
2021-06-17 07:55:22 -07:00
Jordan Sissel
d50f756d0e
Bump version prepare to release.
2021-01-19 15:12:20 -08:00
Chris Hodges
50ca2bfd05
Update virtualenv documentation for Python3
...
Original `virtualenv-tools` causes issues when building Python3 virtual environments. Previously reported in #1491 .
2021-01-19 13:08:17 -08:00
Kenyon Ralph
7d7b184d63
virtualenv.rst: fix heading level
...
This makes the "Example uses" heading a subsection of the virtualenv section.
2021-01-19 12:21:30 -08:00