diff --git a/src/c.md b/src/c.md index 28b04c3..397aaa0 100644 --- a/src/c.md +++ b/src/c.md @@ -1,5 +1,18 @@ # Notes on C +- [Notes on C](#notes-on-c) + - [Basics](#basics) + - [Enums](#enums) + - [Pointers](#pointers) + - [Arrays](#arrays) + - [Structs](#structs) + - [Unions](#unions) + - [Qualifiers](#qualifiers) + - [Preprocessor](#preprocessor) + - [Some Best Practices](#some-best-practices) + - [Some Headers](#some-headers) + - [Bibliography](#bibliography) + ## Basics The minimal "hello world" C program: diff --git a/src/cpp.md b/src/cpp.md index 7fe750f..4fa9f63 100644 --- a/src/cpp.md +++ b/src/cpp.md @@ -1,5 +1,28 @@ # Notes on C++ +- [Notes on C++](#notes-on-c) + - [Basics](#basics) + - [User-Defined Types](#user-defined-types) + - [Modularity](#modularity) + - [Classes](#classes) + - [Constructors](#constructors) + - [Copy Constructors](#copy-constructors) + - [Copy Assignment](#copy-assignment) + - [Move Constructor](#move-constructor) + - [Operations](#operations) + - [Templates](#templates) + - [Generic Programming](#generic-programming) + - [Standard Library](#standard-library) + - [Strings and Regex](#strings-and-regex) + - [I/O](#io) + - [Containers](#containers) + - [Algorithms](#algorithms) + - [Utilities](#utilities) + - [Numerics](#numerics) + - [Concurrency](#concurrency) + - [References](#references) + + ## Basics The minimal "hello world" C++ program: diff --git a/src/cython.md b/src/cython.md index de5805e..c52b70a 100644 --- a/src/cython.md +++ b/src/cython.md @@ -1,5 +1,22 @@ # Notes on Cython +- [Notes on Cython](#notes-on-cython) + - [Compilation](#compilation) + - [Using distutils with cythonize](#using-distutils-with-cythonize) + - [Typing](#typing) + - [Typing variables](#typing-variables) + - [C Functions](#c-functions) + - [C Functions with Automatic Python Wrappers](#c-functions-with-automatic-python-wrappers) + - [Exception Handling](#exception-handling) + - [C structs, unions, enums an typedefs](#c-structs-unions-enums-an-typedefs) + - [Efficient Loops](#efficient-loops) + - [Extension Types](#extension-types) + - [Wrapping C++](#wrapping-c) + - [Profiling](#profiling) + - [Typed Memoryviews](#typed-memoryviews) + - [Parallelism](#parallelism) + - [References](#references) + ## Compilation ### Using distutils with cythonize diff --git a/src/jl_dive.md b/src/jl_dive.md index f685641..4ae08e6 100644 --- a/src/jl_dive.md +++ b/src/jl_dive.md @@ -1,5 +1,28 @@ # Julia Deep Dive +- [Julia Deep Dive](#julia-deep-dive) + - [Basics](#basics) + - [Data Types and Structures](#data-types-and-structures) + - [Scalar Types](#scalar-types) + - [Basic Math](#basic-math) + - [Strings](#strings) + - [Arrays](#arrays) + - [Multidimensional and Nested Arrays](#multidimensional-and-nested-arrays) + - [Tuples](#tuples) + - [Named Tuples](#named-tuples) + - [Dictionaries](#dictionaries) + - [Sets](#sets) + - [Memory and Copy](#memory-and-copy) + - [Random Numbers](#random-numbers) + - [Basic Syntax](#basic-syntax) + - [Functions](#functions) + - [Custom Types](#custom-types) + - [I/O](#io) + - [Metaprogramming](#metaprogramming) + - [Exceptions](#exceptions) + - [DataFrames](#dataframes) + - [References](#references) + ## Basics The minimal "hello world" program: diff --git a/src/py_tips.md b/src/py_tips.md index 6758840..578156d 100644 --- a/src/py_tips.md +++ b/src/py_tips.md @@ -1,5 +1,31 @@ # Python Tips +- [Python Tips](#python-tips) + - [General Project Guidance](#general-project-guidance) + - [Project Layout](#project-layout) + - [Versioning](#versioning) + - [PEP 440 / PyPA Guidelines](#pep-440--pypa-guidelines) + - [Semantic Versioning](#semantic-versioning) + - [Linting and Formating](#linting-and-formating) + - [Ruff](#ruff) + - [Configuration](#configuration) + - [PyRight](#pyright) + - [Modules, Libraries and Frameworks](#modules-libraries-and-frameworks) + - [Importing](#importing) + - [`sys` Module](#sys-module) + - [Import Paths](#import-paths) + - [Useful Standard Libraries](#useful-standard-libraries) + - [Documentation](#documentation) + - [Documenting API Changes](#documenting-api-changes) + - [Diátaxis](#diátaxis) + - [Generating Documentation from Docstrings](#generating-documentation-from-docstrings) + - [Doctesting](#doctesting) + - [Release Engineering](#release-engineering) + - [Poetry](#poetry) + - [Tox](#tox) + - [The Abstract Syntax Tree](#the-abstract-syntax-tree) + - [Bibliography](#bibliography) + ## General Project Guidance ### Project Layout diff --git a/src/rust.md b/src/rust.md index f0abafb..cd95bcd 100644 --- a/src/rust.md +++ b/src/rust.md @@ -1,5 +1,15 @@ # Notes on Rust +- [Notes on Rust](#notes-on-rust) + - [Basics](#basics) + - [Importing and Namespaces](#importing-and-namespaces) + - [Panic, Options and Result](#panic-options-and-result) + - [Lifetime](#lifetime) + - [Memory](#memory) + - [Stack and Heap](#stack-and-heap) + - [Ownership](#ownership) + - [References](#references) + ## Basics Rust's philosophy: