From 341a5820ab384fe4b3c36921a0784951a40bd6f8 Mon Sep 17 00:00:00 2001 From: Ashley Bao Date: Tue, 28 Mar 2023 09:02:28 -0400 Subject: [PATCH] updated documentation --- docs/Generating_Documentation.html | 3 ++- scripts/GenerateDocs.sh | 1 + src/docs_src/Generating_Documentation.md | 5 ++++- 3 files changed, 7 insertions(+), 2 deletions(-) mode change 100644 => 100755 scripts/GenerateDocs.sh diff --git a/docs/Generating_Documentation.html b/docs/Generating_Documentation.html index 4fdb00c..3cbd7a3 100644 --- a/docs/Generating_Documentation.html +++ b/docs/Generating_Documentation.html @@ -1,5 +1,6 @@ Generating Documentation for Propeller

Project

Topics

Namespaces

Generating Documentation for Propeller

-

To generate documentation with codox, run scripts/GenerateDocs.shin the command line. This will run “lein codox” on the command line to generate first batch of HTMl files. Then, it runs FunctionsToMD to take Push instructions generated by def-instruction and spit it out to a Markdown file. Then, it runs HTMLFix to fix the ordered lists in Adding_Genetic_Operators.md, Adding_Problem.md, and Adding_Selection_Method.md.

+

In order to generate documentation, you’ll need Python and pip installed.

+

To generate documentation with codox, run scripts/GenerateDocs.shin the command line from the scripts directory. To make the script executable, you may need to first run chmod +x GenerateDocs.sh. This will run “lein codox” on the command line to generate first batch of HTMl files. Then, it runs FunctionsToMD to take Push instructions generated by def-instruction and spit it out to a Markdown file. Then, it runs HTMLFix to fix the ordered lists in Adding_Genetic_Operators.md, Adding_Problem.md, and Adding_Selection_Method.md.

\ No newline at end of file diff --git a/scripts/GenerateDocs.sh b/scripts/GenerateDocs.sh old mode 100644 new mode 100755 index 7d4af79..e77ac43 --- a/scripts/GenerateDocs.sh +++ b/scripts/GenerateDocs.sh @@ -1,5 +1,6 @@ #!/bin/sh +pip install mdutils lein codox python3 FunctionsToMD.py python3 HTMLFix.py diff --git a/src/docs_src/Generating_Documentation.md b/src/docs_src/Generating_Documentation.md index 15a3337..3606aaf 100644 --- a/src/docs_src/Generating_Documentation.md +++ b/src/docs_src/Generating_Documentation.md @@ -1,6 +1,9 @@ # Generating Documentation for Propeller -To generate documentation with [codox](https://github.com/weavejester/codox), run `scripts/GenerateDocs.sh`in the command line. +In order to generate documentation, you'll need Python and `pip` installed. + +To generate documentation with [codox](https://github.com/weavejester/codox), run `scripts/GenerateDocs.sh`in the command line from the `scripts` directory. +To make the script executable, you may need to first run `chmod +x GenerateDocs.sh`. This will run "lein codox" on the command line to generate first batch of HTMl files. Then, it runs FunctionsToMD to take Push instructions generated by `def-instruction` and spit it out to a Markdown file. Then, it runs HTMLFix to fix the ordered lists in `Adding_Genetic_Operators.md`, `Adding_Problem.md`, and