Reorganize project structure (#80)

* move the documentation to a separate directory, update scrips and .gitignore * add readme with instructions
key4hep · Dec 17, 2024 · bff98fc · bff98fc
1 parent 324d182
commit bff98fc
Show file tree

Hide file tree

Showing 39 changed files with 68 additions and 36 deletions.
diff --git a/.github/scripts/fetch_external_sources.sh b/.github/scripts/fetch_external_sources.sh
@@ -54,6 +54,6 @@ fetch_for_file() {
   done < ${file_to_proc}
 }
 
-fetch_for_file README.md
-fetch_for_file tutorials/README.md
-fetch_for_file how-tos/README.md
+fetch_for_file docs/index.md
+fetch_for_file docs/tutorials/README.md
+fetch_for_file docs/how-tos/README.md
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -21,8 +21,8 @@ jobs:
         bash .github/scripts/fetch_external_sources.sh
     - name: Sphinx build
       run: |
-        sphinx-build -M html . build
-        sphinx-build -b linkcheck . linkcheck
+        sphinx-build -M html docs build
+        sphinx-build -b linkcheck docs linkcheck
     - uses: actions/upload-pages-artifact@v3
       with:
         path: build/html
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -30,7 +30,7 @@ jobs:
         bash .github/scripts/fetch_external_sources.sh
     - name: Sphinx build
       run: |
-        sphinx-build -M html . build
+        sphinx-build -M html docs build
     - name: Publish gh-pages
       run: |
         cd build/html

diff --git a/.gitignore b/.gitignore
@@ -19,4 +19,5 @@ linkcheck
 k4marlinwrapper/
 k4simdelphes/
 key4hep-tutorials
-how-tos
+k4fwcore/
+k4edm4hep2lcioconv
diff --git a/README.md b/README.md
@@ -1,30 +1,32 @@
-# Key4hep
-
-
-```{eval-rst}
-.. toctree::
-    :maxdepth: 3
-    :includehidden:
-    :caption: Contents:
-
-    setup-and-getting-started/README.md
-    how-tos/README.md
-    tutorials/README.md
-    developing-key4hep-software/README.md
-    spack-build-instructions-for-librarians/README.md
-    talks-and-presentations/README.md
-    call-for-logos/README.md
-    CONTRIBUTING.md
-
-.. toctree::
-    :maxdepth: 2
-    :includehidden:
-    :caption: External links:
-
-    FCC software  <https://cern.ch/fccsw>
-    CLIC software <https://twiki.cern.ch/twiki/bin/view/CLIC/CLICSoftwareComputing>
-    ILC software <https://ilcsoft.desy.de/portal>
-    CEPC software <http://cepcsoft.ihep.ac.cn/>
-    Muon Collider software <https://mcd-wiki.web.cern.ch/software/>
+# Key4hep documentation
+[![docs](https://img.shields.io/badge/docs-main-blue.svg)](https://key4hep.github.io/key4hep-doc/)
+
+Key4hep central documentation
+
+## Getting dependencies
+
+Install python dependencies:
+
+```sh
+pip install -r requirements.txt
+```
+
+## Building locally
+
+First fetch the documentation pages from other key4hep repositories:
+
+```sh
+.github/scripts/fetch_external_sources.sh 
+```
+
+Then build the site locally:
+
+```sh
+sphinx-build -M html docs build
 ```
 
+Check the links validity with:
+
+```
+sphinx-build -b linkcheck docs linkcheck
+```
diff --git a/CONDUCT.md → docs/CONDUCT.md b/CONDUCT.md → docs/CONDUCT.md
diff --git a/CONTRIBUTING.md → docs/CONTRIBUTING.md b/CONTRIBUTING.md → docs/CONTRIBUTING.md
diff --git a/LICENSE.md → docs/LICENSE.md b/LICENSE.md → docs/LICENSE.md
diff --git a/call-for-logos/README.md → docs/call-for-logos/README.md b/call-for-logos/README.md → docs/call-for-logos/README.md
diff --git a/call-for-logos/key4hep_logo1.svg → docs/call-for-logos/key4hep_logo1.svg b/call-for-logos/key4hep_logo1.svg → docs/call-for-logos/key4hep_logo1.svg
diff --git a/call-for-logos/key4hep_logo2.svg → docs/call-for-logos/key4hep_logo2.svg b/call-for-logos/key4hep_logo2.svg → docs/call-for-logos/key4hep_logo2.svg
diff --git a/call-for-logos/key4hep_logo3.png → docs/call-for-logos/key4hep_logo3.png b/call-for-logos/key4hep_logo3.png → docs/call-for-logos/key4hep_logo3.png
diff --git a/call-for-logos/key4hep_logo4.svg → docs/call-for-logos/key4hep_logo4.svg b/call-for-logos/key4hep_logo4.svg → docs/call-for-logos/key4hep_logo4.svg
diff --git a/call-for-logos/key4hep_logo5.svg → docs/call-for-logos/key4hep_logo5.svg b/call-for-logos/key4hep_logo5.svg → docs/call-for-logos/key4hep_logo5.svg
diff --git a/call-for-logos/key4hep_logo6.svg → docs/call-for-logos/key4hep_logo6.svg b/call-for-logos/key4hep_logo6.svg → docs/call-for-logos/key4hep_logo6.svg
diff --git a/call-for-logos/key4hep_logo6p1.svg → docs/call-for-logos/key4hep_logo6p1.svg b/call-for-logos/key4hep_logo6p1.svg → docs/call-for-logos/key4hep_logo6p1.svg
diff --git a/call-for-logos/key4hep_logo7.svg → docs/call-for-logos/key4hep_logo7.svg b/call-for-logos/key4hep_logo7.svg → docs/call-for-logos/key4hep_logo7.svg
diff --git a/call-for-logos/key4hep_logo7p1.svg → docs/call-for-logos/key4hep_logo7p1.svg b/call-for-logos/key4hep_logo7p1.svg → docs/call-for-logos/key4hep_logo7p1.svg
diff --git a/conf.py → docs/conf.py b/conf.py → docs/conf.py
diff --git a/developing-key4hep-software/CMakeBuild.md → ...developing-key4hep-software/CMakeBuild.md b/developing-key4hep-software/CMakeBuild.md → ...developing-key4hep-software/CMakeBuild.md
diff --git a/...ing-key4hep-software/Key4hepCMakeGuide.md → ...ing-key4hep-software/Key4hepCMakeGuide.md b/...ing-key4hep-software/Key4hepCMakeGuide.md → ...ing-key4hep-software/Key4hepCMakeGuide.md
diff --git a/...ng-key4hep-software/Key4hepSoftwareGit.md → ...ng-key4hep-software/Key4hepSoftwareGit.md b/...ng-key4hep-software/Key4hepSoftwareGit.md → ...ng-key4hep-software/Key4hepSoftwareGit.md
diff --git a/developing-key4hep-software/README.md → docs/developing-key4hep-software/README.md b/developing-key4hep-software/README.md → docs/developing-key4hep-software/README.md
diff --git a/developing-key4hep-software/SinglePackage.md → ...eloping-key4hep-software/SinglePackage.md b/developing-key4hep-software/SinglePackage.md → ...eloping-key4hep-software/SinglePackage.md
diff --git a/...ng-key4hep-software/SpackForDevelopers.md → ...ng-key4hep-software/SpackForDevelopers.md b/...ng-key4hep-software/SpackForDevelopers.md → ...ng-key4hep-software/SpackForDevelopers.md
diff --git a/...ing-key4hep-software/WritingAlgorithms.md → ...ing-key4hep-software/WritingAlgorithms.md b/...ing-key4hep-software/WritingAlgorithms.md → ...ing-key4hep-software/WritingAlgorithms.md
diff --git a/how-tos/README.md → docs/how-tos/README.md b/how-tos/README.md → docs/how-tos/README.md
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,30 @@
+# Key4hep
+
+
+```{eval-rst}
+.. toctree::
+    :maxdepth: 3
+    :includehidden:
+    :caption: Contents:
+
+    setup-and-getting-started/README.md
+    how-tos/README.md
+    tutorials/README.md
+    developing-key4hep-software/README.md
+    spack-build-instructions-for-librarians/README.md
+    talks-and-presentations/README.md
+    call-for-logos/README.md
+    CONTRIBUTING.md
+
+.. toctree::
+    :maxdepth: 2
+    :includehidden:
+    :caption: External links:
+
+    FCC software  <https://cern.ch/fccsw>
+    CLIC software <https://twiki.cern.ch/twiki/bin/view/CLIC/CLICSoftwareComputing>
+    ILC software <https://ilcsoft.desy.de/portal>
+    CEPC software <http://cepcsoft.ihep.ac.cn/>
+    Muon Collider software <https://mcd-wiki.web.cern.ch/software/>
+```
+
diff --git a/logo.svg → docs/logo.svg b/logo.svg → docs/logo.svg
diff --git a/setup-and-getting-started/README.md → docs/setup-and-getting-started/README.md b/setup-and-getting-started/README.md → docs/setup-and-getting-started/README.md
diff --git a/...ild-instructions-for-librarians/README.md → ...ild-instructions-for-librarians/README.md b/...ild-instructions-for-librarians/README.md → ...ild-instructions-for-librarians/README.md
diff --git a/...ructions-for-librarians/spack-advanced.md → ...ructions-for-librarians/spack-advanced.md b/...ructions-for-librarians/spack-advanced.md → ...ructions-for-librarians/spack-advanced.md
diff --git a/...ctions-for-librarians/spack-buildcache.md → ...ctions-for-librarians/spack-buildcache.md b/...ctions-for-librarians/spack-buildcache.md → ...ctions-for-librarians/spack-buildcache.md
diff --git a/...uctions-for-librarians/spack-nightlies.md → ...uctions-for-librarians/spack-nightlies.md b/...uctions-for-librarians/spack-nightlies.md → ...uctions-for-librarians/spack-nightlies.md
diff --git a/...nstructions-for-librarians/spack-setup.md → ...nstructions-for-librarians/spack-setup.md b/...nstructions-for-librarians/spack-setup.md → ...nstructions-for-librarians/spack-setup.md
diff --git a/starterkit.png → docs/starterkit.png b/starterkit.png → docs/starterkit.png
diff --git a/talks-and-presentations/README.md → docs/talks-and-presentations/README.md b/talks-and-presentations/README.md → docs/talks-and-presentations/README.md
diff --git a/tutorials/README.md → docs/tutorials/README.md b/tutorials/README.md → docs/tutorials/README.md
diff --git a/index.md b/index.md