Skip to content

Commit

Permalink
Renamed PJPROJECT to PJSIP Project. To be tagged 2.9
Browse files Browse the repository at this point in the history
  • Loading branch information
bennylp committed Apr 22, 2021
1 parent 5f8c67f commit f8628a9
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 11 deletions.
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,15 +198,16 @@ $ make clean html

Then open `docs/build/html/index.html` to preview the result.

#### 4. Git commit (but don't push yet)
#### 4. Git commit and push

```sh
$ cd pjproject_docs
$ git add -u
$ git commit -m 'Setting pjproject version to 2.10'
$ git push
```

Note: don't push the repository yet to avoid triggering unnecessary build in RTD.
This should trigger a building process for version `latest` in RTD.


#### 5. Tag pjproject_docs
Expand All @@ -225,16 +226,14 @@ $ cd pjproject_docs
$ git push --tags
```

This should trigger a building process in RTD.

#### 7. See the building process

Open https://readthedocs.org/projects/pjsip/builds/, there should be one that is currently building.
You may wait until it is finished (it will take approximately 15 minutes) to make sure that everything is okay or do the next step.
You may wait until it is finished (it will take approximately 15 minutes) to make sure that everything is okay, otherwise continue the next steps (but it will cause more than one build processes to be started by RTD, which is okay).

#### 8. Activate the version

Go to https://readthedocs.org/projects/pjsip/versions/, and activate the new version and make it public.
Go to https://readthedocs.org/projects/pjsip/versions/, and activate the new version and make it active and public.

This will trigger a build process for that version.

Expand Down
4 changes: 2 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

# Which pjproject tag to checkout to create the documentation.
# Set to "master" to checkout the latest version
pjproject_tag = '1.16'
pjproject_tag = '2.9'

# Doxygen XML files to be sanitized because it contains characters causing XML parsing to fail
sanitize_xml_files = [
Expand Down Expand Up @@ -93,7 +93,7 @@

# -- Project information -----------------------------------------------------

project = 'PJPROJECT'
project = 'PJSIP Project'
copyright = '2021, Teluu'
author = 'Teluu Team'

Expand Down
21 changes: 19 additions & 2 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
.. PJPROJECT documentation master file, created by
.. PJSIP Project documentation master file, created by
sphinx-quickstart on Mon Feb 24 12:26:01 2020.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
==============================
PJPROJECT Online Documentation
PJSIP Project Online Documentation
==============================


Expand All @@ -14,11 +14,28 @@ PJPROJECT Online Documentation

intro
consider
datasheet

.. toctree::
:maxdepth: 2
:caption: PJSUA2:

pjsua2/intro_pjsua2
pjsua2/endpoint
pjsua2/account
pjsua2/media
pjsua2/call
pjsua2/presence
pjsua2/samples
pjsua2/media_quality
pjsua2/network_problems


.. toctree::
:maxdepth: 2
:caption: API Reference:

api/pjsua2
api/pjsua_lib
api/pjsip
api/pjmedia
Expand Down
2 changes: 1 addition & 1 deletion docs/source/pjproject
Submodule pjproject updated 1704 files

0 comments on commit f8628a9

Please sign in to comment.