Remove docs from Github CI build.

rerdavies · Jan 7, 2025 · ee625c0 · ee625c0
1 parent 53bd9c9
commit ee625c0
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 5 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -13,4 +13,7 @@ add_subdirectory("examples/hello_world")
 add_subdirectory("examples/hello_world2")
 add_subdirectory("examples/context_edit")
 
-add_subdirectory("docs")
+# Docs are built by seperate CI step on github. The main CI build doesn't have NPM/Node JS installed.
+if(NOT DEFINED ENV{GITHUB_ACTIONS})
+    add_subdirectory("docs")
+endif()
diff --git a/README.md b/README.md
@@ -1,10 +1,12 @@
 #### NWindows TUI Library
 <!--[![Build Status](https://github.com/reravies/nwindows.svg?branch=master)](https://github.com/rerdavies/nwindows) -->
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![Documentation](https://img.shields.io/badge/documentation-Developer%20Guide-blue)](https://reravies.github.io/nwindows/)
+[![Documentation](https://img.shields.io/badge/documentation-Developer%20Guide-blue)](https://reravies.github.io/nwindows/documentation)
 [![Documentation](https://img.shields.io/badge/documentation-Examples-blue)](https://reravies.github.io/nwindows/examples)
 <!--[![Documentation](https://img.shields.io/badge/documentation-Release%20Notes-blue)](https://reravies.github.io/nwindows/) -->
 
+INITIAL DEPLOYMENT IN PROGRESS. NOT YET READY FOR USE!!!
+
 The *NWindows* library is a C++ text user interface (TUI) library for building console applications on Linux.
 The library uses elements to compose user interfaces using an innovative and concise manipulator system. The library provides a rich set of elements with which to build user interfaces.
 

diff --git a/docs/src/App.tsx b/docs/src/App.tsx
@@ -1,13 +1,15 @@
 import React, { useEffect } from 'react';
 import logo from '/logo.svg'
 
-import './App.css'
-import Toolbar from '@mui/material/Toolbar'
-import Button from '@mui/material/Button'
+import './App.css';
+import Toolbar from '@mui/material/Toolbar';
+import Button from '@mui/material/Button';
+import IconButton from '@mui/material/IconButton';
 import HomeIcon from '@mui/icons-material/Home';
 import ArticleIcon from '@mui/icons-material/Article';
 import ApiIcon from '@mui/icons-material/Api';
 import ArrowDropdownIcon from '@mui/icons-material/ArrowDropDown';
+import GitHubIcon from '@mui/icons-material/GitHub';
 
 import Divider from '@mui/material/Divider'
 import Paper from '@mui/material/Paper'
@@ -139,6 +141,11 @@ function App() {
                                     return true;
                                 }} />
                         )}
+                        <IconButton onClick={()=>{
+                            window.open("https://github.com/rerdavies/nwindows/","_blank");
+                        }}> 
+                            <GitHubIcon />
+                        </IconButton>
                     </React.Fragment>) :
                         (<React.Fragment>
                             {/************* COMPACT NAV BAR */}

diff --git a/docs/src/pages/HomePage.tsx b/docs/src/pages/HomePage.tsx
@@ -11,6 +11,7 @@ function HomePage() {
         <PageColumn>
             <div>
                 <Banner subtitle="TUI Library"/>
+                <p>INITIAL DEPLOYMENT IN PROGRESS. NOT YET READY FOR USE!!!</p>
                 <p>
                     The <span className="name">NWindows</span> library is a C++ text user interface (TUI) library for building console applications.
                     The library uses elements to compose user interfaces using an innovative and concise manipulator system. The library provides a