mirror of
https://github.com/Hopiu/django-markdownx.git
synced 2026-03-17 05:50:23 +00:00
Merge branch 'master' of ssh://github.com/neutronX/django-markdownx
* 'master' of ssh://github.com/neutronX/django-markdownx: Fix the compiling docs from sphinx to mkdocs
This commit is contained in:
commit
8cdad13f94
2 changed files with 4 additions and 33 deletions
9
dev.py
9
dev.py
|
|
@ -48,9 +48,8 @@ DEV_XML_FILE = 'dev.xml'
|
|||
XML_FILE_ABSOLUTE_PATH = join_path(BASE_DIR, DEV_XML_FILE)
|
||||
|
||||
pypi_packages = {
|
||||
'sphinx',
|
||||
'sphinx-classy-code',
|
||||
'sphinxcontrib-autoanysrc',
|
||||
'mkdocs',
|
||||
'pymdown-extensions',
|
||||
}
|
||||
|
||||
|
||||
|
|
@ -62,9 +61,7 @@ bash_commands = {
|
|||
'/srv/django-markdownx/manage.py runserver 0.0.0.0:8000"'
|
||||
),
|
||||
'docs': (
|
||||
'cd {}'.format(join_path(BASE_DIR, 'docs-src', '_theme', 'sphinx_rtd_theme')),
|
||||
'{python} setup.py clean install'.format(python=python_path),
|
||||
'cd ../..'
|
||||
'mkdocs build',
|
||||
),
|
||||
'docker': (
|
||||
'docker-compose build',
|
||||
|
|
|
|||
28
dev.xml
28
dev.xml
|
|
@ -160,37 +160,11 @@ failures = test_runner(
|
|||
failfast=False).run_tests(['tests'])
|
||||
sys.exit(failures)</contents>
|
||||
</file>
|
||||
<file for="docs">
|
||||
<path>Makefile</path>
|
||||
<contents># Minimal makefile for Sphinx documentation
|
||||
#
|
||||
|
||||
# You can set these variables from the command line.
|
||||
SPHINXOPTS =
|
||||
SPHINXBUILD = sphinx-build
|
||||
SPHINXPROJ = DjangoMarkdownx
|
||||
SOURCEDIR = docs-src
|
||||
BUILDDIR = docs
|
||||
|
||||
# Put it first so that "make" without argument is like "make help".
|
||||
help:
|
||||
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||
|
||||
.PHONY: help Makefile
|
||||
|
||||
# Catch-all target: route all unknown targets to Sphinx using the new
|
||||
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
||||
%: Makefile
|
||||
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)</contents>
|
||||
</file>
|
||||
<file for="docs"><path>create_docs.sh</path>
|
||||
<contents>#!/usr/bin/env bash
|
||||
|
||||
# Compile the docs.
|
||||
make clean
|
||||
make html
|
||||
|
||||
mv ./docs/html/* ./docs/
|
||||
mkdocs build
|
||||
|
||||
# Open in the browser.
|
||||
URL="docs/index.html"
|
||||
|
|
|
|||
Loading…
Reference in a new issue