Comments (16)
see to it that they get distributed properly.
from coala.
see #33 - also sphinx could be a possible solution here
from coala.
sphinx doc gets introduced with #107 hope we can make some nice manpage out of this but it will require additional worl
from coala.
moving to 0.2, this is linux/unix only. For now we have the help output and the tutorial introduced in #273
from coala.
might be related to #302
from coala.
so its probably best to generate them from argparse or so, please see http://bugs.python.org/issue14102 . Here's a tutorial: https://andialbrecht.wordpress.com/2009/03/17/creating-a-man-page-with-distutils-and-optparse/
from coala.
maybe we can use http://crunchyfrog.googlecode.com/svn/tags/0.3.4/utils/command/build_manpage.py to generate the man page from our setup.py, could someone investigate?
from coala.
I finally used https://raw.githubusercontent.com/pwman3/pwman3/d718a01fa8038893e42416b59cdfcda3935fe878/build_manpage.py and made our own modified version
from coala.
#711 can generate manpages using python setup.py build_manpage
or python setup.py build
but this is not installed (just created in coala's root) nor does it run with python setup.py install
Still needs work.
from coala.
Apparently this doesn't seem feasible without a custom bash script which is made to run after the install command.
It's nicely documented here - beetbox/beets#1501
from coala.
Postponing bug until 0.3. I still think we'll want a manpage, even if it needs a custom bash script.
from coala.
So, apparently it's really bad if we install man page along with pip
and setuptools. It's highly unrecommended - because then you can't use the package in a virtualenv easily.
So, it is recommended to add the manpage as a data_file and use the distribution's package manager to install manpages to the correct directory.
I think this is a valid point not to do this
from coala.
that makes me sad :( I had a dream... a dream in which coala has a man page... a dream in which every python program has an autogenerated manpage. Well...
from coala.
This issue is not yet complete.
I still need to make it work with python setup.py install
from coala.
Hey, so ... I have slight issues with making it work with python setup.py install
To make it install with setup.py install
I need to do this:
class BuildPyCommand(setuptools.command.build_py.build_py):
def run(self):
self.run_command('build_manpage')
setuptools.command.build_py.build_py.run(self)
This makes the coala.1
file when I run python setup.py install
. But now to move it to the installation path - i need to add to package_data
. But it checks if the file exists before the run
is called.
So, we have 2 options:
- Make an empty
coala.1
file which will be filled when running the install - Override the
__init__
or something to run thebuild_manpage
before the file's existence is checked.
I prefer the first.
from coala.
Nevermind. I can fix this by using data_files
rather than package_data
from coala.
Related Issues (20)
- test pipeline of travis.ci broken HOT 1
- Update URL of Travis CI in Adding_CI.rst HOT 3
- autopep8 section of .coafile fails
- Uniform string formatting HOT 18
- Required changes to sync moban HOT 1
- Throughput Graph in README needs to be updated HOT 2
- Link Does not exist HOT 3
- Add pytest to requirements.txt HOT 13
- Travis build failure due to setuptools-git HOT 2
- BuildManPage.py: Invalid syntax HOT 2
- Please invite me to the GitHub Community Organization
- Please invite me to the GitHub Community Organization
- I'm interested in joining coal and would love to contribute in your work.
- " An unknown error occurred. This is a bug. We are sorry for the inconvenience. Please contact the developers"
- Broken search
- cib not working, source code cannot be found
- Project dependencies have API risk issues
- ImportError: cannot import name 'Iterable' from 'collections' HOT 3
- Unable to use CheckstyleBear in .coafile
- Is this project still under maintaining? HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from coala.