From ba338a6409354d9b9ebde443842f8c99f88646bd Mon Sep 17 00:00:00 2001 From: Nicolas Chauvat Date: Mon, 4 May 2020 09:21:57 +0200 Subject: Rename to README.rst to make heptapod display it correctly --- README | 78 ---------------------------------------------------------- README.rst | 78 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ docs/index.rst | 2 +- setup.py | 2 +- 4 files changed, 80 insertions(+), 80 deletions(-) delete mode 100644 README create mode 100644 README.rst diff --git a/README b/README deleted file mode 100644 index 643579f..0000000 --- a/README +++ /dev/null @@ -1,78 +0,0 @@ -Logilab's common library -======================== - -What's this ? -------------- - -This package contains some modules used by different Logilab projects. - -It is released under the GNU Lesser General Public License. - -There is no documentation available yet but the source code should be clean and -well documented. - -Designed to ease: - -* handling command line options and configuration files -* writing interactive command line tools -* manipulation of files and character strings -* manipulation of common structures such as graph, tree, and pattern such as visitor -* generating text and HTML reports -* more... - -Documentation -------------- - -Documentation is available at https://logilab-common.readthedocs.io/ - -Installation ------------- - -logilab-common is available on pypi so you can install it using pip :: - - pip install logilab-common - -Or alternatively extract the tarball, jump into the created directory and run :: - - python setup.py install - -For installation options, see :: - - python setup.py install --help - - -Building the documentation --------------------------- - -Create a virtualenv and install dependencies :: - - virtualenv venv - source venv/bin/activate - - # you need the krb5-config command to build all dependencies - # on debian you can get it using "apt-get install libkrb5-dev" - - pip install doc/requirements-doc.txt - - # install logilab-common - pip install -e . - -Then build the doc :: - - cd doc - make html - -It's now available under `doc/_build/html/` - -Comments, support, bug reports ------------------------------- - -Project page https://www.logilab.org/project/logilab-common - -Use the cubicweb-devel at lists.cubicweb.org mailing list. - -You can subscribe to this mailing list at -https://lists.cubicweb.org/mailman/listinfo/cubicweb-devel - -Archives are available at -https://lists.cubicweb.org/pipermail/cubicweb-devel/ diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..643579f --- /dev/null +++ b/README.rst @@ -0,0 +1,78 @@ +Logilab's common library +======================== + +What's this ? +------------- + +This package contains some modules used by different Logilab projects. + +It is released under the GNU Lesser General Public License. + +There is no documentation available yet but the source code should be clean and +well documented. + +Designed to ease: + +* handling command line options and configuration files +* writing interactive command line tools +* manipulation of files and character strings +* manipulation of common structures such as graph, tree, and pattern such as visitor +* generating text and HTML reports +* more... + +Documentation +------------- + +Documentation is available at https://logilab-common.readthedocs.io/ + +Installation +------------ + +logilab-common is available on pypi so you can install it using pip :: + + pip install logilab-common + +Or alternatively extract the tarball, jump into the created directory and run :: + + python setup.py install + +For installation options, see :: + + python setup.py install --help + + +Building the documentation +-------------------------- + +Create a virtualenv and install dependencies :: + + virtualenv venv + source venv/bin/activate + + # you need the krb5-config command to build all dependencies + # on debian you can get it using "apt-get install libkrb5-dev" + + pip install doc/requirements-doc.txt + + # install logilab-common + pip install -e . + +Then build the doc :: + + cd doc + make html + +It's now available under `doc/_build/html/` + +Comments, support, bug reports +------------------------------ + +Project page https://www.logilab.org/project/logilab-common + +Use the cubicweb-devel at lists.cubicweb.org mailing list. + +You can subscribe to this mailing list at +https://lists.cubicweb.org/mailman/listinfo/cubicweb-devel + +Archives are available at +https://lists.cubicweb.org/pipermail/cubicweb-devel/ diff --git a/docs/index.rst b/docs/index.rst index a506420..e7a8609 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,7 +3,7 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -.. include:: ../README +.. include:: ../README.rst Provided modules ---------------- diff --git a/setup.py b/setup.py index 8b8bf65..c11b59b 100644 --- a/setup.py +++ b/setup.py @@ -32,7 +32,7 @@ with open(path.join(here, '__pkginfo__.py')) as f: exec(f.read(), pkginfo) # Get the long description from the relevant file -with open(path.join(here, 'README'), encoding='utf-8') as f: +with open(path.join(here, 'README.rst'), encoding='utf-8') as f: long_description = f.read() setup( -- cgit v1.2.1