Skip to content

📚 Docs #740

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
kris-jusiak wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

📚 Docs #740

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ you contribute:
4. Be sure your modifications include:
* Don't break anything (`make`)
* Proper unit/functional tests (`make test`)
* Documentation updates if required (`make doc`)
* Documentation updates if required (plain Markdown in `docs/`)
* Regenerate preprocessed headers (`tools/pph.sh`)
* Update/check style using (`make check`)
* Verify performance (`make benchmarks`)
Expand Down
51 changes: 0 additions & 51 deletions .github/workflows/docs.yml
View file
Open in desktop

This file was deleted.

23 changes: 4 additions & 19 deletions .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ name: release
# Cut a GitHub Release for the version currently on master.
#
# Manually triggered. It reads BOOST_SML_VERSION from include/boost/sml.hpp,
# creates the matching vX.Y.Z tag (if missing) and a GitHub Release whose notes
# are the matching section of doc/CHANGELOG.md. Safe to re-run: it is a no-op if
# the release already exists.
# creates the matching vX.Y.Z tag (if missing) and a GitHub Release with
# auto-generated notes. Release history lives on the GitHub Releases page.
# Safe to re-run: it is a no-op if the release already exists.

on:
workflow_dispatch:
Expand Down Expand Up @@ -42,21 +42,6 @@ jobs:
echo "tag=v$version" >> "$GITHUB_OUTPUT"
echo "Releasing v$version"

- name: Extract changelog section
id: notes
run: |
version="${{ steps.ver.outputs.version }}"
# Print the block from "## [x.y.z]" up to (but not including) the next "## [".
awk -v v="$version" '
$0 ~ "^## \\[" v "\\]" {grab=1; next}
grab && /^## \[/ {exit}
grab {print}
' doc/CHANGELOG.md > RELEASE_NOTES.md
if [ ! -s RELEASE_NOTES.md ]; then
echo "See doc/CHANGELOG.md" > RELEASE_NOTES.md
fi
echo "----- release notes -----"; cat RELEASE_NOTES.md

- name: Create tag and release (idempotent)
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Expand All @@ -69,4 +54,4 @@ jobs:
gh release create "$tag" \
--target "${{ github.sha }}" \
--title "$tag" \
--notes-file RELEASE_NOTES.md
--generate-notes
24 changes: 0 additions & 24 deletions .mkdocs.yml
View file
Open in desktop

This file was deleted.

12 changes: 2 additions & 10 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,9 @@
# Memcheck: make test MEMCHECK=VALGRIND
# Coverage: make test COVERAGE=GCOV
#
.PHONY: all test example style static_analysis doc serve clean
.PHONY: all test example style static_analysis clean

CXX ?= g++
MKDOCS ?= mkdocs
CXXSTD ?= c++14
_STD = $(subst c++,,$(CXXSTD))
BDIR = build-$(CXXSTD)
Expand Down Expand Up @@ -68,12 +67,5 @@ style: $(BDIR)/.configured
static_analysis: $(BDIR)/.configured
$(CMAKE) --build $(BDIR) --target clang-tidy

# Documentation (https://boost-ext.github.io/sml). Requires: pip install mkdocs
doc:
$(MKDOCS) build --config-file .mkdocs.yml --clean --site-dir site

serve:
$(MKDOCS) serve --config-file .mkdocs.yml

clean:
rm -rf $(BDIR) site
rm -rf $(BDIR)
Loading
Loading