Skip to content
This repository has been archived by the owner on Jan 30, 2023. It is now read-only.

Commit

Permalink
More reorganization of developer guide
Browse files Browse the repository at this point in the history
  • Loading branch information
kcrisman authored and jdemeyer committed Nov 9, 2014
1 parent 8b95db3 commit 7fa0de3
Showing 1 changed file with 42 additions and 13 deletions.
55 changes: 42 additions & 13 deletions src/doc/en/developer/index.rst
Expand Up @@ -10,6 +10,8 @@ Sage at some point. You could:
* Find bugs or typos
* Fix a bug
* Implement a new function
* Contribute a useful tutorial for a mathematical topic
* Translate an existing document to a new language
* Create a new class, create a fast new C library, etc.

This document describes how to write programs using Sage, how to modify
Expand Down Expand Up @@ -42,6 +44,10 @@ to be aware of.
(Looking at newer files and functionality within Sage is another way to
get a sense for the the general style, but refer here for details.)

- There is an entire section on how to modify or add to the various
:ref:`manuals and tutorials <chapter-sage_manuals>`,
including localizing to other languages.

- Finally, in order to share changes with the Sage community, you will
need to learn some basics of the source code revision control process.
There are several places to start, depending upon your previous knowledge.
Expand All @@ -51,17 +57,19 @@ to be aware of.
software <section-git-install>` if you don't already have it.
- Then you will need to go through a short process to :ref:`configure git
<section-git-setup-name>` for use with Trac.
- An overview of the Sage development process, assuming you have ``git``
installed and know the basics of how to use it, is in the :ref:`concise
development guide <chapter-walkthrough>`.
- More advanced :ref:`tricks and tips <section-git-tricks-and-tips>` for
``git`` are linked below.
- For those unfamiliar with revision control, please start by reading
about :ref:`collaborative development with Git-Trac <chapter-git_trac>`,
- Assuming you have ``git`` installed and know the basics of how to use it,
the next step is the overview of the Sage development flow in the
:ref:`concise development guide <chapter-walkthrough>`.

- (More advanced :ref:`tricks and tips <section-git-tricks-and-tips>` for
``git`` are linked below.)

- For those unfamiliar with ``git`` or revision control, please start by
reading about :ref:`collaborative development with Git-Trac <chapter-git_trac>`,
which provides some easier interface with git and Trac, both for newbies
and power users.
- Alternately, one can do certain amounts of Sage development without
having git installed, by using Sage's own internal installation of git
having ``git`` installed, by using Sage's own internal installation of ``git``
and the :ref:`Sage dev scripts <chapter-devscript>`. This is mainly
intended as a bridge to full use of git once one becomes more comfortable
with the system.
Expand Down Expand Up @@ -126,18 +134,41 @@ When ``git trac`` is not enough.
Writing Code for Sage
=====================

Basics of Writing and Testing Sage Code
---------------------------------------

.. toctree::
:maxdepth: 3

coding_basics
doctesting

Contributing to Manuals and Tutorials
-------------------------------------

.. toctree::
:maxdepth: 3

sage_manuals

Sage Coding Details
-------------------

.. toctree::
:maxdepth: 3

coding_in_python
coding_in_cython
coding_in_other

Packaging Third-Party Code
--------------------------

.. toctree::
:maxdepth: 3

packaging
packaging_old_spkgs
doctesting
sage_manuals


Sage Notebook Developer Guide
=============================
Expand All @@ -157,5 +188,3 @@ Indices and tables

This work is licensed under a `Creative Commons Attribution-Share Alike
3.0 License <http://creativecommons.org/licenses/by-sa/3.0/>`_.


0 comments on commit 7fa0de3

Please sign in to comment.