Commit Graph

83 Commits

Author SHA1 Message Date
Jordan Sissel 9bbc223400 Version bump and update changelog 2022-03-31 00:04:53 -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
Avi Miller 304619416b This improves the Oracle Linux install docs by removing the additional
repo that was added and enabling the ol7_optional_latest repo instead.
This ensures that fully supported packages are installed, including
the ruby-devel package.

This also corrects the product name.

Signed-off-by: Avi Miller <avi.miller@oracle.com>
2019-11-19 15:53:29 -08:00
Will H d9ddb21de4 Update outdated "gem install" command
The --no-ri and --no-rdoc switches have now been superseded by --no-document per https://guides.rubygems.org/command-reference/#gem_install
2019-11-19 15:27:41 -08:00
Syed Ali 93e73c7ad5 Updated docs/installing.rst to reflect Oracle Enteprise Linux instructions 2019-02-07 09:31:00 -08:00
Jordan Sissel 294f6180cf Upgrade Sphinx version to fix a crash in 'make build' (where newer sphinx_rtd_theme causes Sphinx 1.4.x to crash) 2018-12-23 14:29:46 -08:00
Jordan Sissel cad736ee6c
Version bump to 1.10.2 (#1516) 2018-07-03 22:11:58 -07:00
Jordan Sissel 3b6a415c35
Regenerate changelog links. (#1513)
I had forgotten how I did this and couldn't find notes, so... here's
how:

```
grep -Eo '`#([0-9]+)`_' CHANGELOG.rst | sed -re 's@^`#([0-9]+)`_$@.. _#\1: https://github.com/jordansissel/fpm/issues/\1@' | sort -u > docs/changelog_links.rst
```

This finds all \`#NNN\`_ entries in the CHANGELOG.rst and puts it sorted
into changelog_links.rst for reStructuredText linking.
2018-07-03 21:30:53 -07:00
Arthur Burkart 68ec00e4cf Fixes typo; claims to make an rpm, but really deb 2018-05-12 21:09:58 -07:00
Anatoli Babenia c7c9043467 Link intro to full list of sources 2018-01-10 20:59:09 -08:00
Anthony Mastrean 8a91a79088 [Fixes #1402] Update files.rst
Update the Jenkins/WAR example to use the more stable addresses, although they do redirect to mirrors and make the wget example output look nasty, it should be more reliable.
2017-09-28 08:36:45 -07:00
Jordan Sissel b7e82d49b4 Version bump 2017-07-29 01:27:51 -07:00
Jordan Sissel fcd4e70662 Try formatting with a definition list 2017-07-28 15:31:28 -07:00