feat: Improve docs

flamapy · May 15, 2024 · 4ed01e1 · 4ed01e1
1 parent fb0027f
commit 4ed01e1
Show file tree

Hide file tree

Showing 23 changed files with 362 additions and 21 deletions.
diff --git a/Gemfile b/Gemfile
@@ -5,4 +5,4 @@ gem "jekyll-github-metadata", ">= 2.15"
 
 gem "jekyll-include-cache", group: :jekyll_plugins
 
-gem "html-proofer", "~> 5.0", :group => :development
+gem "html-proofer", "~> 5.0", :group => :development
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -11,6 +11,32 @@ GEM
   remote: https://rubygems.org/
   specs:
     Ascii85 (1.1.0)
+    actionpack (7.1.3.2)
+      actionview (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      nokogiri (>= 1.8.5)
+      racc
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    actionview (7.1.3.2)
+      activesupport (= 7.1.3.2)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activesupport (7.1.3.2)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
     addressable (2.8.6)
       public_suffix (>= 2.0.2, < 6.0)
     afm (0.2.2)
@@ -19,16 +45,22 @@ GEM
       fiber-annotation
       io-event (~> 1.5, >= 1.5.1)
       timers (~> 4.1)
+    base64 (0.2.0)
     bigdecimal (3.1.7)
+    builder (3.2.4)
     colorator (1.1.0)
     concurrent-ruby (1.2.3)
+    connection_pool (2.4.1)
     console (1.23.6)
       fiber-annotation
       fiber-local
       json
+    crass (1.0.6)
+    drb (2.2.1)
     em-websocket (0.5.3)
       eventmachine (>= 0.12.9)
       http_parser.rb (~> 0)
+    erubi (1.12.0)
     ethon (0.16.0)
       ffi (>= 1.15.0)
     eventmachine (1.2.7)
@@ -39,6 +71,8 @@ GEM
     ffi (1.16.3)
     fiber-annotation (0.2.0)
     fiber-local (1.0.0)
+    font-awesome-rails (4.7.0.8)
+      railties (>= 3.2, < 8.0)
     forwardable-extended (2.6.0)
     google-protobuf (4.26.1-arm64-darwin)
       rake (>= 13)
@@ -57,7 +91,11 @@ GEM
     http_parser.rb (0.8.0)
     i18n (1.14.4)
       concurrent-ruby (~> 1.0)
+    io-console (0.7.2)
     io-event (1.5.1)
+    irb (1.13.1)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
     jekyll (4.3.3)
       addressable (~> 2.4)
       colorator (~> 1.0)
@@ -94,7 +132,12 @@ GEM
     listen (3.9.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
+    loofah (2.22.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
     mercenary (0.4.0)
+    minitest (5.22.3)
+    mutex_m (0.2.0)
     net-http (0.4.1)
       uri
     nokogiri (1.16.4-arm64-darwin)
@@ -112,13 +155,42 @@ GEM
       hashery (~> 2.0)
       ruby-rc4
       ttfunk
+    psych (5.1.2)
+      stringio
     public_suffix (5.0.5)
     racc (1.7.3)
+    rack (3.0.11)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rackup (2.1.0)
+      rack (>= 3)
+      webrick (~> 1.8)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.1.3.2)
+      actionpack (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      irb
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
     rainbow (3.1.1)
     rake (13.2.1)
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
+    rdoc (6.6.3.1)
+      psych (>= 4.0.0)
+    reline (0.5.7)
+      io-console (~> 0.5)
     rexml (3.2.6)
     rouge (4.2.1)
     ruby-rc4 (0.1.5)
@@ -130,13 +202,17 @@ GEM
     sawyer (0.9.2)
       addressable (>= 2.3.5)
       faraday (>= 0.17.3, < 3)
+    stringio (3.1.0)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
+    thor (1.3.1)
     timers (4.3.5)
     ttfunk (1.8.0)
       bigdecimal (~> 3.1)
     typhoeus (1.4.1)
       ethon (>= 0.9.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (2.5.0)
     uri (0.13.0)
     webrick (1.8.1)
@@ -149,6 +225,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (>= 2.3.5)
+  font-awesome-rails (~> 4.7, >= 4.7.0.8)
   html-proofer (~> 5.0)
   jekyll-github-metadata (>= 2.15)
   jekyll-include-cache

diff --git a/README.md b/README.md
@@ -6,4 +6,4 @@ docker compose up -d --build
 ```
 
 You can see the docs in `localhost:4000`
-`
+    
diff --git a/_config.yml b/_config.yml
@@ -134,7 +134,7 @@ liquid:
 back_to_top: true
 back_to_top_text: "Back to top"
 
-footer_content: "<b>flamapy</b>. Distributed by an <a href=\"https://www.gnu.org/licenses/lgpl-3.0.en.html\">LGPL license v3.</a> Contact us: <a href=\"mailto:flamapy@us.es\">flamapy@us.es</a>"
+footer_content: "<span class='flamapy'>flama<span class='blue'>p</span><span class='yellow'>y</span></span>. Distributed by an <a href='https://www.gnu.org/licenses/lgpl-3.0.en.html'>LGPL license v3.</a> Contact us: <a href='mailto:flamapy@us.es'>flamapy@us.es</a>"
 
 # Footer last edited timestamp
 last_edit_timestamp: true # show or hide edit time - page must have `last_modified_date` defined in the frontmatter

diff --git a/_includes/flamapy.html b/_includes/flamapy.html
@@ -0,0 +1,2 @@
+<!-- _includes/flamapy.html -->
+<span class="flamapy">flama<span class="blue">p</span><span class="yellow">y</span></span>
diff --git a/_includes/head.html b/_includes/head.html
@@ -18,6 +18,10 @@
 
   <link rel="stylesheet" href="{{ '/assets/css/just-the-docs-head-nav.css' | relative_url }}" id="jtd-head-nav-stylesheet">
 
+  <link rel="stylesheet" href="{{ "/assets/css/custom.css" | relative_url }}">
+
+  <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.2/css/all.min.css">
+
   <style id="jtd-nav-activation">
   {% include css/activation.scss.liquid %}
   </style>

diff --git a/_includes/nav_footer_custom.html b/_includes/nav_footer_custom.html
@@ -1,6 +1,6 @@
 <footer class="site-footer"> 
 
-    <b>flamapy</b> is sponsored by <a href="https://www.us.es/">University of Seville</a>, 
+    {% include flamapy.html %} is sponsored by <a href="https://www.us.es/">University of Seville</a>, 
     <a href="https://www.uma.es/">University of Malaga</a>, 
     <a href="https://www.uni-graz.at/en/">University of Graz</a> and 
     <a href="https://www.uned.es/universidad/inicio.html">Universidad Nacional de Educación a Distancia (UNED)</a>.

diff --git a/assets/css/custom.css b/assets/css/custom.css
@@ -0,0 +1,13 @@
+/* assets/css/custom.css */
+.flamapy {
+  color: #0C486C; 
+  font-weight: bold;
+}
+
+.flamapy .yellow {
+  color: #FECE3F;
+}
+
+.flamapy .blue {
+  color: #356C99;
+}
diff --git a/assets/css/just-the-docs-light.scss b/assets/css/just-the-docs-light.scss
@@ -1,3 +1,3 @@
 ---
 ---
-{% include css/just-the-docs.scss.liquid color_scheme="light" %}
+{% include css/just-the-docs.scss.liquid color_scheme="light" %}
diff --git a/assets/images/large-image.jpg b/assets/images/large-image.jpg
diff --git a/assets/images/small-image.jpg b/assets/images/small-image.jpg
Original file line number	Diff line number	Diff line change
Expand Up		@@ -5,4 +5,4 @@ gem "jekyll-github-metadata", ">= 2.15"

		gem "jekyll-include-cache", group: :jekyll_plugins

		gem "html-proofer", "~> 5.0", :group => :development
		gem "html-proofer", "~> 5.0", :group => :development
Original file line number	Diff line number	Diff line change
Expand Up		@@ -6,4 +6,4 @@ docker compose up -d --build
		```

		You can see the docs in `localhost:4000`
		`
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		<!-- _includes/flamapy.html -->
		<span class="flamapy">flama<span class="blue">p</span><span class="yellow">y</span></span>