Added waning option. Fixes.

master
Franco Masotti 2 years ago
parent 8e4e751f95
commit 143ba23b24
Signed by: frnmst
GPG Key ID: 24116ED85666780A
  1. 2
      docs/Makefile
  2. 90
      docs/blueprints.rst
  3. 1
      docs/index.rst

@ -3,7 +3,7 @@
# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXOPTS ?= -W
SPHINXBUILD ?= sphinx-build
SOURCEDIR = .
BUILDDIR = _build

@ -1,72 +1,54 @@
Contributing
============
Blueprints
==========
:doc:`Contributing [common] <../contributing_common>` version `0.0.1 <https://github.com/frnmst/fpydocs/releases/tag/0.0.1>`_
Makefile:
Makefile
--------
::
#!/usr/bin/env make
#
# Makefile
#
# Copyright (C) 2017-2020 frnmst (Franco Masotti) <franco.masotti@live.com>
#
# This file is part of md-toc.
#
# md-toc is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# md-toc is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with md-toc. If not, see <http://www.gnu.org/licenses/>.
#
#!/usr/bin/env make
#
# Makefile
#
# <license>
export PACKAGE_NAME=md_toc
export PACKAGE_NAME=md_toc
default: doc
default: doc
doc:
pipenv run $(MAKE) -C docs html
doc: clean
pipenv run $(MAKE) -C docs html
install:
pip3 install . --user
install:
pip3 install . --user
uninstall:
pip3 uninstall $(PACKAGE_NAME)
uninstall:
pip3 uninstall $(PACKAGE_NAME)
install-dev:
pipenv install --dev
pipenv run pre-commit install
install-dev:
pipenv install --dev
pipenv run pre-commit install
uninstall-dev:
pipenv --rm
uninstall-dev:
pipenv --rm
demo:
asciinema/$(PACKAGE_NAME)_asciinema_$$(git describe --tags $$(git rev-list --tags --max-count=1) | tr '.' '_')_demo.sh
demo:
asciinema/$(PACKAGE_NAME)_asciinema_$$(git describe --tags $$(git rev-list --tags --max-count=1) | tr '.' '_')_demo.sh
test:
python -m unittest $(PACKAGE_NAME).tests.tests --failfast --locals --verbose
test:
python -m unittest $(PACKAGE_NAME).tests.tests --failfast --locals --verbose
dist:
pipenv run python setup.py sdist
pipenv run python setup.py bdist_wheel
pipenv run twine check dist/*
dist:
pipenv run python setup.py sdist
pipenv run python setup.py bdist_wheel
pipenv run twine check dist/*
upload:
pipenv run twine upload dist/*
upload:
pipenv run twine upload dist/*
clean:
rm -rf build dist *.egg-info tests/benchmark-results *.md
pipenv run $(MAKE) -C docs clean
clean:
rm -rf build dist *.egg-info tests/benchmark-results *.md
pipenv run $(MAKE) -C docs clean
.PHONY: default doc install uninstall install-dev uninstall-dev test clean demo benchmar
.PHONY: default doc install uninstall install-dev uninstall-dev test clean demo benchmar

@ -16,6 +16,7 @@ Welcome to fpydocs's documentation!
copyright_license
contributing_common
workflow_common
blueprints
Indices and tables
==================

Loading…
Cancel
Save