Browse Source

docs/man -> docs/src and update Makefile and build-helper.

4.2
Darko Poljak 6 years ago
parent
commit
0d64d6a5b6
  1. 13
      .gitignore
  2. 38
      Makefile
  3. 4
      bin/build-helper
  4. 4
      bin/build-helper.freebsd
  5. 0
      docs/src/Makefile
  6. 0
      docs/src/cdist-best-practice.rst
  7. 0
      docs/src/cdist-bootstrap.rst
  8. 0
      docs/src/cdist-explorer.rst
  9. 0
      docs/src/cdist-features.rst
  10. 0
      docs/src/cdist-hacker.rst
  11. 0
      docs/src/cdist-install.rst
  12. 0
      docs/src/cdist-intro.rst
  13. 0
      docs/src/cdist-logo.png
  14. 0
      docs/src/cdist-manifest.rst
  15. 0
      docs/src/cdist-messaging.rst
  16. 0
      docs/src/cdist-os.rst
  17. 0
      docs/src/cdist-quickstart.rst
  18. 0
      docs/src/cdist-reference.rst.sh
  19. 0
      docs/src/cdist-remote-exec-copy.rst
  20. 0
      docs/src/cdist-stages.rst
  21. 0
      docs/src/cdist-support.rst
  22. 0
      docs/src/cdist-troubleshooting.rst
  23. 0
      docs/src/cdist-type.rst
  24. 0
      docs/src/cdist-types.rst
  25. 0
      docs/src/cdist-update.rst
  26. 0
      docs/src/cdist-why.rst
  27. 0
      docs/src/conf.py
  28. 0
      docs/src/index.rst
  29. 0
      docs/src/man1/cdist.rst
  30. 0
      docs/src/man7/.gitignore

13
.gitignore vendored

@ -2,14 +2,11 @@
.*.swp
# Ignore generated manpages
docs/man/.marker
docs/man/man1/*.1
docs/man/man7/*.7
docs/man/man*/*.html
docs/man/man*/*.xml
docs/man/man*/docbook-xsl.css
docs/man/man7/cdist-type__*.rst
docs/man/cdist-reference.rst
docs/src/.marker
docs/src/man1/*.1
docs/src/man7/*.7
docs/src/man7/cdist-type__*.rst
docs/src/cdist-reference.rst
# Ignore cdist cache for version control
/cache/

38
Makefile

@ -20,7 +20,7 @@
helper=./bin/build-helper
MANDIR=docs/man
DOCS_SRC_DIR=docs/src
SPEECHDIR=docs/speeches
TYPEDIR=cdist/conf/type
@ -36,13 +36,13 @@ CHANGELOG_FILE=docs/changelog
PYTHON_VERSION=cdist/version.py
SPHINXM=make -C $(MANDIR) man
SPHINXH=make -C $(MANDIR) html
SPHINXM=make -C $(DOCS_SRC_DIR) man
SPHINXH=make -C $(DOCS_SRC_DIR) html
################################################################################
# Manpages
#
MAN1DSTDIR=$(MANDIR)/man1
MAN7DSTDIR=$(MANDIR)/man7
MAN1DSTDIR=$(DOCS_SRC_DIR)/man1
MAN7DSTDIR=$(DOCS_SRC_DIR)/man7
# Manpages #1: Types
# Use shell / ls to get complete list - $(TYPEDIR)/*/man.rst does not work
@ -56,26 +56,26 @@ $(MAN7DSTDIR)/cdist-type%.rst: $(TYPEDIR)/%/man.rst
ln -sf "../../../$^" $@
# Manpages #2: reference
MANREF=$(MAN7DSTDIR)/cdist-reference.rst
MANREFSH=$(MANDIR)/cdist-reference.rst.sh
DOCSREF=$(MAN7DSTDIR)/cdist-reference.rst
DOCSREFSH=$(DOCS_SRC_DIR)/cdist-reference.rst.sh
$(MANREF): $(MANREFSH)
$(MANREFSH)
$(DOCSREF): $(DOCSREFSH)
$(DOCSREFSH)
# Manpages #3: generic part
mansphinxman: $(MANTYPES) $(MANREF) $(PYTHON_VERSION)
sphinxman: $(MANTYPES) $(DOCSREF) $(PYTHON_VERSION)
$(SPHINXM)
mansphinxhtml: $(MANTYPES) $(MANREF) $(PYTHON_VERSION)
sphinxhtml: $(MANTYPES) $(DOCSREF) $(PYTHON_VERSION)
$(SPHINXH)
man: mansphinxman mansphinxhtml
docs: sphinxman sphinxhtml
# Manpages #5: release part
MANWEBDIR=$(WEBBASE)/man/$(CHANGELOG_VERSION)
MANBUILDDIR=docs/dist/html
man-dist: man
docs-dist: man
rm -rf "${MANWEBDIR}"
mkdir -p "${MANWEBDIR}"
# mkdir -p "${MANWEBDIR}/man1" "${MANWEBDIR}/man7"
@ -102,10 +102,10 @@ $(DOTMAN7DSTDIR)/cdist-type%.rst: $(DOTTYPEDIR)/%/man.rst
ln -sf "$^" $@
# Manpages #3: generic part
dotmansphinxman: $(DOTMANTYPES)
dotsphinxman: $(DOTMANTYPES)
$(SPHINXM)
dotman: dotmansphinxman
dotman: dotsphinxman
################################################################################
@ -147,7 +147,7 @@ web-doc:
web-dist: web-blog web-doc
web-pub: web-dist man-dist speeches-dist
web-pub: web-dist docs-dist speeches-dist
cd "${WEBDIR}" && make pub
web-release-all: man-latest-link
@ -212,12 +212,12 @@ release:
#
clean:
rm -f $(MANDIR)/cdist-reference.rst
rm -f $(DOCS_SRC_DIR)/cdist-reference.rst
find "$(MANDIR)" -mindepth 2 -type l \
find "$(DOCS_SRC_DIR)" -mindepth 2 -type l \
| xargs rm -f
make -C $(MANDIR) clean
make -C $(DOCS_SRC_DIR) clean
find * -name __pycache__ | xargs rm -rf

4
bin/build-helper

@ -206,8 +206,8 @@ eof
"$0" check-date
"$0" check-unittest
# Generate man pages (indirect check if they build)
make man
# Generate documentation (man and html)
make docs
# Generate speeches (indirect check if they build)
make speeches

4
bin/build-helper.freebsd

@ -241,8 +241,8 @@ eof
"$0" check-date
"$0" check-unittest
# Generate man pages (indirect check if they build)
make helper=${helper} WEBDIR=${WEBDIR} man
# Generate documentation (man and html)
make helper=${helper} WEBDIR=${WEBDIR} docs
# Generate speeches (indirect check if they build)
make helper=${helper} WEBDIR=${WEBDIR} speeches

0
docs/man/Makefile → docs/src/Makefile

0
docs/man/cdist-best-practice.rst → docs/src/cdist-best-practice.rst

0
docs/man/cdist-bootstrap.rst → docs/src/cdist-bootstrap.rst

0
docs/man/cdist-explorer.rst → docs/src/cdist-explorer.rst

0
docs/man/cdist-features.rst → docs/src/cdist-features.rst

0
docs/man/cdist-hacker.rst → docs/src/cdist-hacker.rst

0
docs/man/cdist-install.rst → docs/src/cdist-install.rst

0
docs/man/cdist-intro.rst → docs/src/cdist-intro.rst

0
docs/man/cdist-logo.png → docs/src/cdist-logo.png

Before

Width:  |  Height:  |  Size: 1.5 KiB

After

Width:  |  Height:  |  Size: 1.5 KiB

0
docs/man/cdist-manifest.rst → docs/src/cdist-manifest.rst

0
docs/man/cdist-messaging.rst → docs/src/cdist-messaging.rst

0
docs/man/cdist-os.rst → docs/src/cdist-os.rst

0
docs/man/cdist-quickstart.rst → docs/src/cdist-quickstart.rst

0
docs/man/cdist-reference.rst.sh → docs/src/cdist-reference.rst.sh

0
docs/man/cdist-remote-exec-copy.rst → docs/src/cdist-remote-exec-copy.rst

0
docs/man/cdist-stages.rst → docs/src/cdist-stages.rst

0
docs/man/cdist-support.rst → docs/src/cdist-support.rst

0
docs/man/cdist-troubleshooting.rst → docs/src/cdist-troubleshooting.rst

0
docs/man/cdist-type.rst → docs/src/cdist-type.rst

0
docs/man/cdist-types.rst → docs/src/cdist-types.rst

0
docs/man/cdist-update.rst → docs/src/cdist-update.rst

0
docs/man/cdist-why.rst → docs/src/cdist-why.rst

0
docs/man/conf.py → docs/src/conf.py

0
docs/man/index.rst → docs/src/index.rst

0
docs/man/man1/cdist.rst → docs/src/man1/cdist.rst

0
docs/man/man7/.gitignore → docs/src/man7/.gitignore vendored

Loading…
Cancel
Save