Skip to content

Commit

Permalink
doc: Next phase of public docs
Browse files Browse the repository at this point in the history
* Publish all markdown from the repos as place holders for improved
  documentation that's under development
* Work on community support, including documentation about documentation
  contributing and doc build process
* improved organization of content into themed folders

Signed-off-by: David B. Kinder <[email protected]>
  • Loading branch information
dbkinder committed Aug 14, 2024
1 parent dc84721 commit 01d6ca3
Show file tree
Hide file tree
Showing 27 changed files with 2,511 additions and 116 deletions.
13 changes: 8 additions & 5 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -47,13 +47,13 @@ help:
content:
$(Q)mkdir -p $(SOURCEDIR)
$(Q)rsync -a --exclude=$(BUILDDIR) . $(SOURCEDIR)
# $(Q)for dir in $(RSYNC_DIRS); do\
# rsync $(RSYNC_OPTS) ../$$dir $(SOURCEDIR); \
# done
$(Q)for dir in $(RSYNC_DIRS); do\
rsync $(RSYNC_OPTS) ../$$dir $(SOURCEDIR); \
done
# temporarily, copy docs content too (were in the docs-work)
# $(Q)rsync $(RSYNC_OPTS) ../docs/* $(SOURCEDIR)
# $(Q)find $(SOURCEDIR) -type f -empty -name "README.md" -delete
# $(Q)scripts/fix-github-md-refs.sh $(SOURCEDIR)
$(Q)find $(SOURCEDIR) -type f -empty -name "README.md" -delete
$(Q)scripts/fix-github-md-refs.sh $(SOURCEDIR)


html: content
Expand Down Expand Up @@ -90,6 +90,9 @@ ifeq ($(RELEASE),latest)
endif
cd $(PUBLISHDIR)/..; git add -A; git commit -s -m "publish $(RELEASE)"; git push origin main;

server:
cd _build/html; python3 -m http.server


# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(OPTS) is meant as a shortcut for $(SPHINXOPTS).
Expand Down
Loading

0 comments on commit 01d6ca3

Please sign in to comment.