Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial work on fpm docs with sphinx and #1237

Merged
merged 11 commits into from Nov 28, 2016

Conversation

@jordansissel
Copy link
Owner

jordansissel commented Nov 27, 2016

Docs published here: http://semicomplete.com/projects/fpm/index.html

This is a major work in progress and this PR exists as a way to jumpstart work on the docs for fpm.

jordansissel added 11 commits Nov 19, 2016
This time is using Sphinx and reST.

To build: `make build`
The docs will appear in docs/_build/html/
…volume. This is necessary to make the root README.rst available
@jordansissel jordansissel merged commit fe9808f into master Nov 28, 2016
0 of 2 checks passed
0 of 2 checks passed
continuous-integration/travis-ci/pr The Travis CI build failed
Details
continuous-integration/travis-ci/push The Travis CI build failed
Details
@nicobrevin

This comment has been minimized.

Copy link
Contributor

nicobrevin commented Nov 28, 2016

@jordansissel

This comment has been minimized.

Copy link
Owner Author

jordansissel commented Nov 28, 2016

@nicobrevin any help would be so lovely! Some ideas:

  • Review existing content for accuracy, confusion, or typos.
  • Add docs for undocumented things (lots of work in this area):
    • Like: rpm output
    • The template features of -p flag (NAME, ARCH, etc)
    • Example use cases
    • Real-world uses (links to external projects)
@josegonzalez josegonzalez deleted the sphinx branch Nov 28, 2016
@nicobrevin

This comment has been minimized.

Copy link
Contributor

nicobrevin commented Nov 28, 2016

@nicobrevin

This comment has been minimized.

Copy link
Contributor

nicobrevin commented Nov 28, 2016

Something weird going on with make and my fu is weak:

make 
Makefile.sphinx:11: *** recipe commences before first target.  Stop.
@jordansissel

This comment has been minimized.

Copy link
Owner Author

jordansissel commented Nov 30, 2016

@nicobrevin I fixed that a short while ago. Can you try again?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.