Skip to content

Commit

Permalink
refactor build tree to sphinx conventions
Browse files Browse the repository at this point in the history
  • Loading branch information
getreu committed Mar 25, 2017
1 parent cce7e32 commit ecfaea0
Show file tree
Hide file tree
Showing 6 changed files with 40 additions and 36 deletions.
2 changes: 1 addition & 1 deletion README.rst
23 changes: 23 additions & 0 deletions doc/make-doc
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
#!/bin/sh
cd ..
mkdir --parents ./doc/build/html
mkdir ./doc/build/html/_downloads
mkdir --parents ./doc/build/man/man1

# Man page
rst2man ./doc/source/stringsext--man.rst > ./doc/build/man/man1/stringsext.1
rst2html --stylesheet=./doc/source/docutils_basic.css ./doc/source/stringsext--man.rst ./doc/build/html/stringsext--man.html
# You can also use pandoc
#pandoc -s doc/source/stringsext--man.rst -t man -o man/man1/stringsext.1
gzip -f ./doc/build/man/man1/stringsext.1

# Readme page
rst2html --stylesheet=./doc/source/docutils_basic.css ./doc/source/index.rst ./doc/build/html/index.html

ln -sf ./doc/source/index.rst ./README.rst
cd ./doc/build/html/_downloads
ln -sf ../../../../target/* .
ln -sf ../../../../doc/build/man/man1/stringsext.1.gz .


cargo rustdoc -p stringsext -- --no-defaults --passes "collapse-docs" --passes "unindent-comments"
File renamed without changes.
31 changes: 16 additions & 15 deletions doc/src/README.rst → doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,9 @@
************
stringsext
stringsext
************



-------------------------------------------------------------------
stringsext - search for multi-byte encoded strings in binary data.
-------------------------------------------------------------------
Expand All @@ -22,6 +20,8 @@ stringsext - search for multi-byte encoded strings in binary data.
.. image:: https://travis-ci.org/getreu/stringsext.svg?branch=master
:target: https://travis-ci.org/getreu/stringsext

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


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

.. excerpt-end
Documentation
=============

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

Developer documentation
| `API documentation`_
| `Forensic Tool Development with Rust`_
| `API documentation`_
| `Forensic Tool Development with Rust`_
.. _`API documentation`: https://getreu.net/public/downloads/doc/stringsext/./target/doc/stringsext/index.html
.. _`Forensic Tool Development with Rust`: https://getreu.net/public/downloads/doc/forensic-tool-development-with-rust
.. _`API documentation`: https://blog.getreu.net/projects/stringsext/stringsext/index.html
.. _`Forensic Tool Development with Rust`: https://blog.getreu.net/projects/forensic-tool-development-with-rust

Source code
===========
Expand All @@ -77,14 +80,12 @@ Distribution
============

Binaries
Download `stringsext binaries`_ and verify hashes_.
`Download <https://blog.getreu.net/projects/stringsext/_downloads/>`__


Manual page
`stringsext.1.gz`_
`stringsext.1.gz <https://blog.getreu.net/projects/stringsext/_downloads/stringsext.1.gz>`__,

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



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

cargo build --release
./make-doc
./doc/make-doc

#. Install

Expand Down
File renamed without changes.
20 changes: 0 additions & 20 deletions make-doc

This file was deleted.

0 comments on commit ecfaea0

Please sign in to comment.