mdtohtml: restructure docs v1 PROPOSED

Edd Salkield: 1
 restructure docs

 3 files changed, 6 insertions(+), 4 deletions(-)

[PATCH mdtohtml] restructure docs Export this patch

---
 .gitignore                            | 2 +-
 Makefile                              | 8 +++++---
 mdtohtml.1.scd => docs/mdtohtml.1.scd | 0
 3 files changed, 6 insertions(+), 4 deletions(-)
 rename mdtohtml.1.scd => docs/mdtohtml.1.scd (100%)

diff --git a/.gitignore b/.gitignore
index 879797a..88b2533 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,2 +1,2 @@
 mdtohtml
-mdtohtml.1
+docs/mdtohtml.1
diff --git a/Makefile b/Makefile
index 61524e8..9e46607 100644
--- a/Makefile
+++ b/Makefile
@@ -14,8 +14,10 @@ all: mdtohtml mdtohtml.1
 mdtohtml: main.go go.mod go.sum
 	$(GO) build $(GOFLAGS) -o $@
 
-mdtohtml.1: mdtohtml.1.scd
-	scdoc < mdtohtml.1.scd > $@
+docs: docs/mdtohtml.1

Adnan Maolood <me@adnano.co>

2 years ago

The 'all' target needs to be updated as well. It still refers to
the old target.

+
+docs/mdtohtml.1: docs/mdtohtml.1.scd
+	scdoc < docs/mdtohtml.1.scd > $@
 
 clean:
 	$(RM) mdtohtml
@@ -30,4 +32,4 @@ uninstall:
 	$(RM) $(DESTDIR)$(BINDIR)/mdtohtml
 	$(RM) $(DESTDIR)$(MANDIR)/man1/mdtohtml.1
 
-.PHONY: all clean install uninstall
+.PHONY: all docs clean install uninstall
diff --git a/mdtohtml.1.scd b/docs/mdtohtml.1.scd
similarity index 100%
rename from mdtohtml.1.scd
rename to docs/mdtohtml.1.scd
-- 
2.38.0

Adnan Maolood <me@adnano.co>

2 years ago

What's the motivation for this?

Adnan Maolood <me@adnano.co>

2 years ago

If we're going to do this, we should do it for all repositories. Could
you send a similar patch for gmnitohtml as well?