From c8716353afb42e94c6d73eaa535e30d4fc1a1029 Mon Sep 17 00:00:00 2001 From: Iustin Pop Date: Fri, 29 Nov 2019 20:06:42 +0100 Subject: [PATCH] Convert the README to markdown Yay, 2019. --- Makefile | 9 +++++++- README.rst => README.md | 48 ++++++++++++++++++----------------------- doc/conf.py | 9 +++++++- doc/index.rst | 5 +++-- 4 files changed, 40 insertions(+), 31 deletions(-) rename README.rst => README.md (54%) diff --git a/Makefile b/Makefile index 4428ec3..0ff92b1 100644 --- a/Makefile +++ b/Makefile @@ -10,7 +10,7 @@ FULLVER = pylibacl-$(VERSION) DISTFILE = $(FULLVER).tar.gz MODNAME = posix1e.so -RSTFILES = doc/index.rst doc/module.rst NEWS README.rst doc/conf.py +RSTFILES = doc/index.rst doc/module.rst doc/news.rst doc/readme.md doc/conf.py all: doc test @@ -23,6 +23,12 @@ $(DOCHTML)/index.html: $(MODNAME) $(RSTFILES) acl.c doc: $(DOCHTML)/index.html +doc/readme.md: README.md + ln -s ../README.md doc/readme.md + +doc/news.rst: NEWS + ln -s ../NEWS doc/news.rst + dist: fakeroot $(PYTHON) ./setup.py sdist @@ -70,6 +76,7 @@ coverage: clean: rm -rf $(DOCHTML) $(DOCTREES) + rm -f doc/readme.md doc/news.rst rm -f $(MODNAME) rm -f *.so rm -rf build diff --git a/README.rst b/README.md similarity index 54% rename from README.rst rename to README.md index 71465b8..06b7032 100644 --- a/README.rst +++ b/README.md @@ -1,36 +1,31 @@ -pylibacl -======== +# pylibacl This is a Python 3.4+ extension module allows you to manipulate the POSIX.1e Access Control Lists present in some OS/file-systems combinations. -Downloads: go to http://pylibacl.k1024.org/downloads. Latest version +Downloads: go to . Latest version is 0.5.4. The source repository is either at -https://git.k1024.org/pylibacl.git or at -https://github.com/iustin/pylibacl. + or at +. For any issues, please file bugs at -https://github.com/iustin/pylibacl/issues. - -.. image:: https://img.shields.io/travis/iustin/pylibacl - :alt: Travis CI - :target: https://travis-ci.org/iustin/pylibacl -.. image:: https://img.shields.io/coveralls/github/iustin/pylibacl - :alt: Coveralls coverage - :target: https://coveralls.io/github/iustin/pylibacl?branch=master -.. image:: https://img.shields.io/github/release-date/iustin/pylibacl - :alt: GitHub Release Date -.. image:: https://img.shields.io/pypi/v/pylibacl - :alt: PyPI - :target: https://pypi.org/project/pylibacl/ -.. image:: https://img.shields.io/pypi/implementation/pylibacl - :alt: PyPI - Implementation -.. image:: https://img.shields.io/pypi/dm/pylibacl - :alt: PyPI - Downloads - -Requirements ------------- +. + +[![Travis](https://img.shields.io/travis/iustin/pylibacl)](https://travis-ci.org/iustin/pylibacl) +[![Codecov](https://img.shields.io/codecov/c/github/iustin/pylibacl)](https://codecov.io/gh/iustin/pylibacl) +[![Read the Docs](https://img.shields.io/readthedocs/pylibacl)](http://pylibacl.readthedocs.io/en/latest/?badge=latest) +[![GitHub issues](https://img.shields.io/github/issues/iustin/pylibacl)](https://github.com/iustin/pylibacl/issues) +![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/iustin/pylibacl) +[![GitHub release (latest by date)](https://img.shields.io/github/v/release/iustin/pylibacl)](https://github.com/iustin/pylibacl/releases) +[![PyPI](https://img.shields.io/pypi/v/pylibacl)](https://pypi.org/project/pylibacl/) +![Debian package](https://img.shields.io/debian/v/python-pylibacl) +![Ubuntu package](https://img.shields.io/ubuntu/v/python-pylibacl) +![GitHub Release Date](https://img.shields.io/github/release-date/iustin/pylibacl) +![GitHub commits since latest release](https://img.shields.io/github/commits-since/iustin/pylibacl/latest) +![GitHub last commit](https://img.shields.io/github/last-commit/iustin/pylibacl) + +## Requirements pylibacl has been written and tested on Linux, kernel v2.4 or newer, with XFS filesystems; ext2/ext3 should also work. Since release 0.4.0, @@ -48,8 +43,7 @@ Solaris does, but I can't test it. - The sphinx python module, for your python version, if building the documentation. -FreeBSD -+++++++ +## FreeBSD Note that on FreeBSD, ACLs are not enabled by default (at least on UFS file systems). To enable them, run `tunefs -a enabled` on the file diff --git a/doc/conf.py b/doc/conf.py index 5083af5..299bca5 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -31,7 +31,7 @@ extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo'] templates_path = ['_templates'] # The suffix of source filenames. -source_suffix = '.rst' +source_suffix = ['.rst', '.md'] # The encoding of source files. #source_encoding = 'utf-8-sig' @@ -69,6 +69,8 @@ exclude_patterns = ['_build', 'html'] # The reST default role (used for this markup: `text`) to use for all documents. #default_role = None +default_domain = 'python' + # If true, '()' will be appended to :func: etc. cross-reference text. #add_function_parentheses = True @@ -88,6 +90,11 @@ pygments_style = 'sphinx' keep_warnings = True +# Note: this is still needed in Sphinx 1.8 with recommonmark 0.4.0 +# (https://github.com/readthedocs/recommonmark/issues/119): +source_parsers = { + '.md': 'recommonmark.parser.CommonMarkParser', +} # -- Options for HTML output --------------------------------------------------- diff --git a/doc/index.rst b/doc/index.rst index 5581815..b47a5b6 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -2,8 +2,8 @@ Welcome to pylibacl's documentation! ====================================== -.. include:: ../README.rst - :start-line: 2 +See the :doc:`README ` for start, or the detailed :doc:`module +` information. Contents -------- @@ -11,6 +11,7 @@ Contents .. toctree:: :maxdepth: 2 + readme.md module.rst implementation.rst news.rst -- 2.39.5