Setup script
Create a setup script with the following steps:
-
Make symlinks, for files such as(needed symlinks already created during build time):-
(no longer needed, see #2 (closed))Pipfile
-
(no longer needed, see #2 (closed))Pipfile.lock
-
(optional)Makefile
-
(optional)Makefile.onion-mkdocs
-
(optional)docs/assets/tor-logo1x.png
-
(optional)docs/assets/favicon.png
-
(optional)docs/site.css
-
- Copy files such as
mkdocs.yml
.gitlab-ci.yml
-
.gitlab-ci-base.yml
(optional if CI template not to be used)
- Create files such as:
.gitlab-ci.yml
-
(optionally, to setMakefile.local
ONION_MKDOCS_PATH
if Makefiles are to be used)
- Switch the INHERIT param at
mkdocs.yml
pointing to the baseonion-mkdocs.yml
location (needed if Onion MkDocs is included as a submodule).
With the following functionality:
- Accepts a destination folder argument (defaulting to the current folder).
- A dry-run flag.
- Do not overwrite existing destinations. Instead, be verbose telling the operator to check the existing files and fix manually.
Ideally, this script should do all the bulk to setup Onion MkDocs in an existing project.
An alternative is to use templater, but then it would be another dependency to be installed.
Edited by Silvio Rhatto