diff options
| author | 1138-4EB <1138-4EB@users.noreply.github.com> | 2019-11-11 18:46:36 +0000 |
|---|---|---|
| committer | tgingold <tgingold@users.noreply.github.com> | 2019-11-11 19:46:36 +0100 |
| commit | 8599d9ddd15b15afdeced6059b1e1b7a972f4db1 (patch) | |
| tree | 499b9c6fe0f85ce7ed221f72ac31036eefde0194 /doc/Makefile | |
| parent | 22775978be88c5ea8e5b740734e42eeb2fef0968 (diff) | |
| download | ghdl-8599d9ddd15b15afdeced6059b1e1b7a972f4db1.tar.gz ghdl-8599d9ddd15b15afdeced6059b1e1b7a972f4db1.tar.bz2 ghdl-8599d9ddd15b15afdeced6059b1e1b7a972f4db1.zip | |
Update doc (#1003)
* doc: update makefile and build scripts
* actions: add workflow 'doc'
* doc: reorganize sections
* doc: fix 'unknown option' warnings, headings, spaces, etc.
* doc: add subdir 'examples', move 'quick_start' sources
* doc: add section 'Development/Debugging'
* doc: add section'Development/Synthesis'
* doc: update roadmap
* doc: add section examples
* doc: use standard domain
* doc: add comment about 'vhd' vs 'vhdl'
Diffstat (limited to 'doc/Makefile')
| -rw-r--r-- | doc/Makefile | 34 |
1 files changed, 25 insertions, 9 deletions
diff --git a/doc/Makefile b/doc/Makefile index d43a1887c..5f111c4d3 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -30,14 +30,36 @@ CP=cp SPHINXOPTS = SPHINXBUILD = sphinx-build PAPER = -BUILDDIR = build +BUILDDIR = _build PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees -T -D language=en $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . all: ghdl.info +#--- + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + +#--- + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + +#--- + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + +#--- + +texi: ghdl.texi +ghdl.texi: $(SRCS) + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + $(CP) $(BUILDDIR)/texinfo/GHDL.texi $@ + info: ghdl.info ghdl.info: ghdl.texi makeinfo -o $@ $< @@ -53,13 +75,7 @@ pdf: ghdl.pdf ghdl.pdf: ghdl.dvi dvipdf $< -html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - -texi: ghdl.texi -ghdl.texi: $(SRCS) - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - $(CP) $(BUILDDIR)/texinfo/GHDL.texi $@ +#--- clean: $(RM) *~ *.dvi *.info ghdl.aux ghdl.cp ghdl.fn ghdl.ky ghdl.log |