4. Code and Documentation Update
4.1. Code Update
Push Code Changes from Server to GitHub
After modifying the code on your server, push the code to GitHub:git add . git commit -m "your comment" git push -u origin <your-branch>:<github-branch> # if it fails, try git push -u origin <your-branch>:<github-branch> --force
Add Submodule
If you want to make contributions to the PaleoDA, try to add it as a submodulecd PaleoDA git submodule add https://github.com/<your-repository> <submodule-name>
Pull Updated Code from GitHub to Server
Once the code on GitHub is updated (by you or others), update the code on your server:cd PaleoDA git submodule update --remote <submodule-name> git add <submodule-name> git commit -m "your comment" git push -u origin <your-branch>:<github-branch>
4.2. Documentation Update
Preview HTML Documentation Locally
Open the HTML documentation locally using a live server to review your changes:cd PaleoDA_docs/build/html live-server
Edit Documentation Source Files
To add or modify documentation content, change to the source directory, edit the relevant.rstfiles, then return to the main documentation directory to rebuild the HTML:cd PaleoDA_docs/source/pages # Make edits to the .rst files cd ../../ make clean make html
Deploy Updated Documentation to GitHub
Copy the newly generated HTML files frombuild/htmltodocsand push the updated files to GitHub:cp -r PaleoDA_docs/build/html/* PaleoDA_docs/docs/ git add * git commit -m "your comment" git push -u origin <your-branch>:<github-branch>