Skip to content

Commit ecfaea0

Browse files
getreugetreu
committed
refactor build tree to sphinx conventions
1 parent cce7e32 commit ecfaea0

File tree

6 files changed

+40
-36
lines changed

6 files changed

+40
-36
lines changed

‎README.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
./doc/src/README.rst
1+
./doc/source/index.rst

‎doc/make-doc‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
#!/bin/sh
2+
cd ..
3+
mkdir --parents ./doc/build/html
4+
mkdir ./doc/build/html/_downloads
5+
mkdir --parents ./doc/build/man/man1
6+
7+
# Man page
8+
rst2man ./doc/source/stringsext--man.rst > ./doc/build/man/man1/stringsext.1
9+
rst2html --stylesheet=./doc/source/docutils_basic.css ./doc/source/stringsext--man.rst ./doc/build/html/stringsext--man.html
10+
# You can also use pandoc
11+
#pandoc -s doc/source/stringsext--man.rst -t man -o man/man1/stringsext.1
12+
gzip -f ./doc/build/man/man1/stringsext.1
13+
14+
# Readme page
15+
rst2html --stylesheet=./doc/source/docutils_basic.css ./doc/source/index.rst ./doc/build/html/index.html
16+
17+
ln -sf ./doc/source/index.rst ./README.rst
18+
cd ./doc/build/html/_downloads
19+
ln -sf ../../../../target/* .
20+
ln -sf ../../../../doc/build/man/man1/stringsext.1.gz .
21+
22+
23+
cargo rustdoc -p stringsext -- --no-defaults --passes "collapse-docs" --passes "unindent-comments"

doc/src/docutils_basic.css renamed to doc/source/docutils_basic.css

File renamed without changes.

doc/src/README.rst renamed to doc/source/index.rst

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,9 @@
66
77
88
************
9-
stringsext
9+
stringsext
1010
************
1111

12-
13-
1412
-------------------------------------------------------------------
1513
stringsext - search for multi-byte encoded strings in binary data.
1614
-------------------------------------------------------------------
@@ -22,6 +20,8 @@ stringsext - search for multi-byte encoded strings in binary data.
2220
.. image:: https://travis-ci.org/getreu/stringsext.svg?branch=master
2321
:target: https://travis-ci.org/getreu/stringsext
2422

23+
.. excerpt-begin
24+
2525
**stringsext** is a Unicode enhancement of the *GNU strings* tool with
2626
additional functionalities: **stringsext** recognizes Cyrillic, CJKV
2727
characters and other scripts in all supported multi-byte-encodings,
@@ -39,6 +39,7 @@ encoding names based on the WHATWG Encoding Standard. When more than one
3939
encoding is specified, the scan is performed in different threads
4040
simultaneously.
4141

42+
4243
When searching for UTF-16 encoded strings, 96% of all possible two byte
4344
sequences, interpreted as UTF-16 code unit, relate directly to a Unicode
4445
code point. As a result, the probability of encountering valid Unicode
@@ -53,19 +54,21 @@ non-text files.
5354
When invoked with ``stringsext -e ascii -c i`` **stringsext** can be
5455
used as *GNU strings* replacement.
5556

57+
.. excerpt-end
58+
59+
5660
Documentation
5761
=============
5862

5963
User documentation
60-
`manual
61-
page <https://getreu.net/public/downloads/doc/stringsext/./doc/build/stringsext--man.html>`__
64+
`manual page <https://blog.getreu.net/projects/stringsext/stringsext--man.html>`__
6265

6366
Developer documentation
64-
| `API documentation`_
65-
| `Forensic Tool Development with Rust`_
67+
| `API documentation`_
68+
| `Forensic Tool Development with Rust`_
6669
67-
.. _`API documentation`: https://getreu.net/public/downloads/doc/stringsext/./target/doc/stringsext/index.html
68-
.. _`Forensic Tool Development with Rust`: https://getreu.net/public/downloads/doc/forensic-tool-development-with-rust
70+
.. _`API documentation`: https://blog.getreu.net/projects/stringsext/stringsext/index.html
71+
.. _`Forensic Tool Development with Rust`: https://blog.getreu.net/projects/forensic-tool-development-with-rust
6972

7073
Source code
7174
===========
@@ -77,14 +80,12 @@ Distribution
7780
============
7881

7982
Binaries
80-
Download `stringsext binaries`_ and verify hashes_.
83+
`Download <https://blog.getreu.net/projects/stringsext/_downloads/>`__
84+
8185

8286
Manual page
83-
`stringsext.1.gz`_
87+
`stringsext.1.gz <https://blog.getreu.net/projects/stringsext/_downloads/stringsext.1.gz>`__,
8488

85-
.. _`stringsext binaries`: https://getreu.net/public/downloads/doc/stringsext/./target/
86-
.. _hashes: https://getreu.net/public/sha256sum.txt
87-
.. _`stringsext.1.gz`: https://getreu.net/public/downloads/doc/stringsext/./man/man1/stringsext.1.gz
8889

8990

9091

@@ -104,7 +105,7 @@ Building and installing
104105
Enter the *Stringsext* source directory where the file ``Cargo.toml`` resides. Then execute::
105106

106107
cargo build --release
107-
./make-doc
108+
./doc/make-doc
108109

109110
#. Install
110111

doc/src/stringsext--man.rst renamed to doc/source/stringsext--man.rst

File renamed without changes.

‎make-doc‎

Lines changed: 0 additions & 20 deletions
This file was deleted.

0 commit comments

Comments
 (0)