search

orakaro / rainbowstream

A smart and nice Twitter client on terminal written in Python.
https://github.com/orakaro/rainbowstream
MIT License
3.54k stars 260 forks source link

make man: Unknown target name: "create an issue" #244

Open waldyrious opened 7 years ago

waldyrious commented 7 years ago

I just tried locating the manpage for rainbowstream, and was having some trouble locating it, so I decided to compile it myself to check. Here's what I did:

$ git clone git@github.com:orakaro/rainbowstream.git # (suppressed: The usual git clone output) $ cd rainbowstream/ $ make man make: No rule to make target 'man'. Stop. $ cd docs/ $ make man Makefile:12: The 'sphinx-build' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the 'sphinx-build' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/. Stop. $ pip install --user sphinx-build Collecting sphinx-build Could not find a version that satisfies the requirement sphinx-build (from versions: ) No matching distribution found for sphinx-build $ pip install --user sphinx # (suppressed: The usual pip install output) $ make man sphinx-build -b man -d _build/doctrees . build/man Running Sphinx v1.6.3 making output directory... loading pickled environment... not yet created building [mo]: targets for 0 po files that are out of date building [man]: all manpages updating environment: 1 added, 0 changed, 0 removed reading sources... [100%] index
/home/waldyrious/.local/src/rainbowstream/docs/index.rst:68: WARNING: Unknown target name: "create an issue"._ looking for now-outdated files... none found pickling environment... done checking consistency... done writing... rainbowstream.1 { } build succeeded, 1 warning.

Build finished. The manual pages are in _build/man.

I left the command sequence pretty much intact, so you can identify potential friction points for newcomers, but the crucial part (the one this issue is reporting) is the warning

/home/waldyrious/.local/src/rainbowstream/docs/index.rst:68: WARNING: Unknown target name: "create an issue".

I'm not sure how that can be fixed (otherwise I'd submit a PR), but hopefully it's not too hard. Cheers!

waldyrious commented 7 years ago

By the way, while attempting to render the man page I had just generated, I got two warnings, but I'm not sure that warrants a new bug -- let me know:

$ groff -man -Tascii rainbowstream.1
rainbowstream.1:36: warning: can't find character with input code 226
rainbowstream.1:36: warning: can't find character with input code 166
RAINBOWSTREAM(1)                 RainbowStream                RAINBOWSTREAM(1)

NAME
       rainbowstream - RainbowStream Documentation

       Terminal-based  Twitter Client. Realtime tweetstream, compose, search ,
       favorite  and much more fun directly from terminal.

(rest of output clipped)