Skip to content

Commit

Permalink
Add table of contents
Browse files Browse the repository at this point in the history
Signed-off-by: Emanuel Lima <emanuel-lima@outlook.com>
  • Loading branch information
emanuellima1 committed Mar 13, 2024
1 parent ac3237c commit ce296c9
Show file tree
Hide file tree
Showing 6 changed files with 112 additions and 0 deletions.
13 changes: 13 additions & 0 deletions src/c.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
23 changes: 23 additions & 0 deletions src/cpp.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
17 changes: 17 additions & 0 deletions src/cython.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
23 changes: 23 additions & 0 deletions src/jl_dive.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
26 changes: 26 additions & 0 deletions src/py_tips.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
10 changes: 10 additions & 0 deletions src/rust.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down

0 comments on commit ce296c9

Please sign in to comment.