Advanced Computer Setup and Topics

Contents:

• ReadTheDocs Documentation System
  • Getting Started with Sphinx
  • Getting Started with MkDocs
  • Importing Your Documentation
  • docutils reStructuredText Directives - This is the official definition - This is the true resource
  • reStructured Text Special directives
  • colored boxes: note, seealso, todo and warnings
  • Paragraph Level Markup
  • Custom Domains and White Labeling
  • ReadTheDocs - Frequently Asked Questions
  • Canonical URLs
  • Enabling Google Analytics on your Project
  • User-defined Redirects
  • Technical Documentation Search Engine Optimization (SEO) Guide
  • Wiping a Build Environment
  • Feature Flags
  • Reproducible Builds
  • Localization of Documentation
  • Manage Translations
  • ReadTheDocs Documentation System
  • Purpose
  • Documentation for RTD
  • ReadTheDocs Theme and Demo Documentation
• Visual Studio Code SSH Remote Development with Containers
  • Visual Studio Code - VSCode Dev Containers
  • VSCode Remote development on Digitalocean
  • How To Use Visual Studio Code: Developing inside a Container
  • How To Use Visual Studio Code for Remote Development via the Remote-SSH Plugin
  • VSCode Remote Development using SSH
  • Remote Development Tips and Tricks
  • vscode-theme-generator
• Sphinx Documentation System
  • Excellent overview at ScribeTools of Sphinx
  • Anaconda Documentation: Detailed reStructuredText and Sphinx example file
  • Sphinx documentation contents
• Bareos Project - Reference Implementation
  • What is Bareos?
  • reST Overview
  • Common Names
  • Specific Formatting
  • Bareos Specific Formatting
  • Gotchas
  • The bareos conf.py looks as follows
  • Configuration File
• Introduction to Developing in the Docker Container Workflow
  • Docker Containers
  • > Pull and run a Python Miniconda container
  • > Best practices
• Docker and Sphinx
  • Docker
  • Install Docker Engine on Debian
  • Docker: Post-installation steps for Linux
  • How To Install and Use Docker on Debian 10
  • Docker Sphinx - Good end-to-end overview
  • digitalocean/sample-dockerfile
  • Official docker-sphinx
  • SphinXsearch Jul 7, 2014. Sphinx in Docker. The basics.
  • docker-sphinxsearch
  • keimlink/docker-sphinx-doc
  • sphinxdocker/Dockerfile
  • Gitlab CI with Docker and Sphinx
  • ReadTheDocs - Getting Started with Sphinx
• Google Bing Webmaster Tools Search and Rich Results
  • New Topics to add
  • Google Structured Data Testing tool
  • Google Search Rich Results Test
  • Bing Webmasters Tools
  • Search Central - Developers.google.com - Build and submit a sitemap
• Binder usage with Sphinx-Gallery
  • Binder - Getting Started with Binder
  • Simple Binder usage with Sphinx-Gallery through Jupytext
• How To Install Python on Debian
  • How To Install .tar.gz Or .tgz Packages In Linux
  • How To Install Python 3.9 on Debian 10
• Invenio Software
  • Invenio Software Overview
  • Invenio Software - Showcase - many major websites use Invenio
• pip is the package installer for Python
  • pip - pip is the package installer for Python
  • pip - Installation
• Sphinx Copybutton
• Sphinx embed object iFrame video html PDF Twitter examples
  • Docutils documentation - Raw Data Pass-Through - Raw Directive
  • Fix key mapping issues - cannot paste larger clips when doing copy-paste in vscode - intermittently the past few months
  • Recommendation for key mapping issues in vscode - settings to adjust
  • Example of embedded YouTube video (works)
  • Example of embedded GitHub Project Issue Kanban board - for this project (Need to do this)
  • Use a large figure as a cover on a link (but people may not know to click it to download the PDF)
  • How to use an <object> that embeds a PDF into a sphinx rst page as a link (works only as a link)
  • How to insert a javascript in a single Sphinx page and create an alert box? (does not work)
  • Example of embedded Twitter page (does not work)
  • Embed a player using the IFrame Player API (perfect)
  • Example of embedded GIF hosted elsewhere (need to scale or make fullscreen)
  • Example of sphinx page with embedded other website using “embed” (needs to scale properly)
  • Example of sphinx page with embedded other website using “object” (needs to scale properly)
  • Example of sphinx page with embedded other website using “iframe” (needs to scale properly)
  • Example 2 of sphinx page with embedded other website using “iframe” (needs to scale properly)
  • Example of sphinx page with a javascript button onClick calling a function calling an alert box (works)
  • How can i insert html and css and javascript both in a sphinx’s reStructuredText file ? (does not work)
• Sphinx Lillypond
• sphinx-last-updated-by-git
  • Project Homepage
• Get the “last updated” time for each Sphinx page from Git
• Sphinx Twitter (Python Twitter)
• Sphinx Gallery
  • Sphinx - Gallery of Examples
  • Sunpy loop edge enhancement python script
  • SunPy Example Gallery - generated vis sphinx
• Sphinx Gitstamp Generator Extension
  • Installing
  • See Who Is Using It
  • Contributing
  • Maintaining PyPI Version
  • License
• Sphinx Jinja is a templating engine
  • Jinja is a fast, expressive, extensible templating engine
  • Customizing Sphinx Simple, Normal, and Hard
  • Jinja
  • documentation.help
  • sphinx-jinja - A sphinx extension to include jinja based templates based documentation into a sphinx doc
• Sphinx Hoverxref
  • https://raw.githubusercontent.com/readthedocs/sphinx-hoverxref/master/docs/index.rst
  • Welcome to sphinx-hoverxref! https://sphinx-hoverxref.readthedocs.io/en/latest/
  • installation https://sphinx-hoverxref.readthedocs.io/en/latest/installation.html
  • usage https://sphinx-hoverxref.readthedocs.io/en/latest/usage.html
  • configuration https://sphinx-hoverxref.readthedocs.io/en/latest/configuration.html
  • development https://sphinx-hoverxref.readthedocs.io/en/latest/development.html
  • API Reference https://sphinx-hoverxref.readthedocs.io/en/latest/autoapi/hoverxref/index.html
• Welcome to sphinx-hoverxref!
  • Usage
  • Reference
• Sphinx PDF Embed - sphinxcontrib-pdfembed
• Sphinx Remote Literal Include
  • Here is how to call the extension for remote literal include for example.java
  • Here is how to call the extension for remote literal include for README.md using line numbers
  • Here is how to call the extension for remote literal include for README.md embedded
• Sphinx Redirects
• Sphinx Rediraffe
  • Installation
  • Usage
  • Diff Checker
  • Auto Redirect builder
  • Options
  • Example Config
  • redirects only (file)
  • redirects only (dict)
  • redirects + diff checker
  • redirects with jinja template
  • Testing
• Sphinx Sitemap
• Sphinx Templating
  • Sphinx - Templating via documentation.help
• Sphinx Timeline
• Werkzeug WSGI web application library
  • Werkzeug is a WSGI web application library
  • Werkzeug Definition
• WSGI is the Web Server Gateway Interface
  • What is WSGI?
  • Learn about WSGI¶
• Zenodo
  • Zenodo - my test sandbox repo
  • Zenodo developers - REST API - QUickstart
  • Zenodo - Principals and Policies about open data and attribution of every object
  • Zenodo - Infrastructure
  • Zenodo - policies
  • Zenodo - make a deposit
• Zotero
  • zotero translators
  • zotero web api v3
  • zotero creating locate engines using opensearch
  • zotero - exposing metadata
  • zotero.org/support/brand many different icons
• Kubernetes
  • Install Nodejs and npm
  • Install and Set Up kubectl
  • Personalizing containers with dotfile repositories
  • Install Docker
  • Install a Docker image with DigitalOcean Kubernetes and doctl
  • Install doctl DigitalOcean CLI
  • Get a token from DigitalOcean
  • Create a DigitalOcean Kubernetes cluster
  • Connect to DigitalOcean Kubernetes cluster
  • Goals
  • Docker Hub
  • Kubernetes Quickstart
  • Getting Started with Kubernetes: A kubectl Cheat Sheet
• GitHub Workflow
  • How do use branching in GitHub
  • How to submit a pull request for someone to accept your submission
  • How another project ‘Minimal Mistakes’ guides contributors in their Pull Request process

Last change: Tue, 03 Aug 2021 10:25 PM UTC