Remove file index, only use group index (issue #1)

pjsip · Feb 29, 2020 · c612d89 · c612d89
1 parent 393b409
commit c612d89
Show file tree

Hide file tree

Showing 6 changed files with 77 additions and 90 deletions.
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 ## Overview
 
-This repository contains configurations to generate https://pjsip.readthedocs.io site.
+This repository contains source and configuration files to generate https://pjsip.readthedocs.io site.
 
 ### Directory Layout
 

diff --git a/docs/source/api/pjlib.rst b/docs/source/api/pjlib.rst
@@ -72,66 +72,66 @@ API Reference
 Basic Types and Functions
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-- :doc:`Configs & Macros <generated/generated/pjlib/group/group__pj__config>`
-- :doc:`Basic Types and Init/Shutdown Functions <generated/generated/pjlib/group/group__PJ__BASIC>`
-- :doc:`DLL Build Target <generated/generated/pjlib/group/group__pj__dll__target>`
+- :doc:`Configs & Macros <generated/pjlib/group/group__pj__config>`
+- :doc:`Basic Types and Init/Shutdown Functions <generated/pjlib/group/group__PJ__BASIC>`
+- :doc:`DLL Build Target <generated/pjlib/group/group__pj__dll__target>`
 
 
 Infrastructure
 ^^^^^^^^^^^^^^^^^^^^^
 
 - Error Number Management
 
-  - :doc:`Errno Framework <generated/generated/pjlib/group/group__pj__errno>`
-  - :doc:`Standard Error Constants <generated/generated/pjlib/group/group__pj__errnum>`
+  - :doc:`Errno Framework <generated/pjlib/group/group__pj__errno>`
+  - :doc:`Standard Error Constants <generated/pjlib/group/group__pj__errnum>`
 
-- :doc:`Ctype <generated/generated/pjlib/group/group__pj__ctype>`
-- :doc:`Logging <generated/generated/pjlib/group/group__PJ__LOG>`
-- :doc:`Assertion <generated/generated/pjlib/group/group__pj__assert>`
-- :doc:`Math <generated/generated/pjlib/group/group__pj__math>`
-- :doc:`Exception Handling <generated/generated/pjlib/group/group__PJ__EXCEPT>`
+- :doc:`Ctype <generated/pjlib/group/group__pj__ctype>`
+- :doc:`Logging <generated/pjlib/group/group__PJ__LOG>`
+- :doc:`Assertion <generated/pjlib/group/group__pj__assert>`
+- :doc:`Math <generated/pjlib/group/group__pj__math>`
+- :doc:`Exception Handling <generated/pjlib/group/group__PJ__EXCEPT>`
 
 
 Data structure
 ^^^^^^^^^^^^^^^
 
-- :doc:`Array <generated/generated/pjlib/group/group__PJ__ARRAY>` 
-- :doc:`Hash Table <generated/generated/pjlib/group/group__PJ__HASH>`
-- :doc:`Linked List <generated/generated/pjlib/group/group__PJ__LIST>`
-- :doc:`RB Tree <generated/generated/pjlib/group/group__PJ__RBTREE>`
+- :doc:`Array <generated/pjlib/group/group__PJ__ARRAY>` 
+- :doc:`Hash Table <generated/pjlib/group/group__PJ__HASH>`
+- :doc:`Linked List <generated/pjlib/group/group__PJ__LIST>`
+- :doc:`RB Tree <generated/pjlib/group/group__PJ__RBTREE>`
 
 
 Network
 ^^^^^^^^^^
 
 - Address Resolution
 
-  - :doc:`IP Helper <generated/generated/pjlib/group/group__pj__ip__helper>`
-  - :doc:`Address Resolution <generated/generated/pjlib/group/group__pj__addr__resolve>`
+  - :doc:`IP Helper <generated/pjlib/group/group__pj__ip__helper>`
+  - :doc:`Address Resolution <generated/pjlib/group/group__pj__addr__resolve>`
 
 - Network I/O
 
-  - :doc:`Socket <generated/generated/pjlib/group/group__PJ__SOCK>`
-  - :doc:`select() Abstraction <generated/generated/pjlib/group/group__PJ__SOCK__SELECT>`
-  - :doc:`Active Socket <generated/generated/pjlib/group/group__PJ__ACTIVESOCK>`
-  - :doc:`IOQueue <generated/generated/pjlib/group/group__PJ__IOQUEUE>`
+  - :doc:`Socket <generated/pjlib/group/group__PJ__SOCK>`
+  - :doc:`select() Abstraction <generated/pjlib/group/group__PJ__SOCK__SELECT>`
+  - :doc:`Active Socket <generated/pjlib/group/group__PJ__ACTIVESOCK>`
+  - :doc:`IOQueue <generated/pjlib/group/group__PJ__IOQUEUE>`
 
-- :doc:`SSL Socket <generated/generated/pjlib/group/group__PJ__SSL__SOCK>`
+- :doc:`SSL Socket <generated/pjlib/group/group__PJ__SSL__SOCK>`
 
 File
 ^^^^^^^^^^
-- :doc:`File Access <generated/generated/pjlib/group/group__PJ__FILE__ACCESS>`
-- :doc:`File I/O <generated/generated/pjlib/group/group__PJ__FILE__IO>`
+- :doc:`File Access <generated/pjlib/group/group__PJ__FILE__ACCESS>`
+- :doc:`File I/O <generated/pjlib/group/group__PJ__FILE__IO>`
 
 
 Memory Management
 ^^^^^^^^^^^^^^^^^^^^^
-- :doc:`Introduction to Memory Pool <generated/generated/pjlib/group/group__PJ__POOL__GROUP>`
-- :doc:`Pool <generated/generated/pjlib/group/group__PJ__POOL>`
-- :doc:`Pool on Fixed Buffer <generated/generated/pjlib/group/group__PJ__POOL__BUFFER>`
-- :doc:`Caching Pool <generated/generated/pjlib/group/group__PJ__CACHING__POOL>`
+- :doc:`Introduction to Memory Pool <generated/pjlib/group/group__PJ__POOL__GROUP>`
+- :doc:`Pool <generated/pjlib/group/group__PJ__POOL>`
+- :doc:`Pool on Fixed Buffer <generated/pjlib/group/group__PJ__POOL__BUFFER>`
+- :doc:`Caching Pool <generated/pjlib/group/group__PJ__CACHING__POOL>`
 
-  - :doc:`Pool Factory Concept <generated/generated/pjlib/group/group__PJ__POOL__FACTORY>`
+  - :doc:`Pool Factory Concept <generated/pjlib/group/group__PJ__POOL__FACTORY>`
 
 
 
@@ -140,52 +140,52 @@ String & Unicode
 String in PJLIB is non-zero terminated, and represented with ``pj_str_t``. A full
 set of API is provided to manipulate such strings.
 
-- :doc:`String Manipulations <generated/generated/pjlib/group/group__PJ__PSTR>`
-- :doc:`Unicode Helper <generated/generated/pjlib/group/group__PJ__UNICODE>`
+- :doc:`String Manipulations <generated/pjlib/group/group__PJ__PSTR>`
+- :doc:`Unicode Helper <generated/pjlib/group/group__PJ__UNICODE>`
 
 
 
 Multithreading and Concurrency
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-- :doc:`Thread <generated/generated/pjlib/group/group__PJ__THREAD>`
+- :doc:`Thread <generated/pjlib/group/group__PJ__THREAD>`
 - Concurrency
 
-  - :doc:`Atomic Operation <generated/generated/pjlib/group/group__PJ__ATOMIC>`
-  - :doc:`Critical Section <generated/generated/pjlib/group/group__PJ__CRIT__SEC>`
-  - :doc:`Mutex <generated/generated/pjlib/group/group__PJ__MUTEX>`
-  - :doc:`RW Mutex <generated/generated/pjlib/group/group__PJ__RW__MUTEX>`
-  - :doc:`Semaphore <generated/generated/pjlib/group/group__PJ__SEM>`
-  - :doc:`Lock <generated/generated/pjlib/group/group__PJ__LOCK>`
-  - :doc:`Group Lock <generated/generated/pjlib/group/group__PJ__GRP__LOCK>`
-  - :doc:`Event <generated/generated/pjlib/group/group__PJ__EVENT>`
+  - :doc:`Atomic Operation <generated/pjlib/group/group__PJ__ATOMIC>`
+  - :doc:`Critical Section <generated/pjlib/group/group__PJ__CRIT__SEC>`
+  - :doc:`Mutex <generated/pjlib/group/group__PJ__MUTEX>`
+  - :doc:`RW Mutex <generated/pjlib/group/group__PJ__RW__MUTEX>`
+  - :doc:`Semaphore <generated/pjlib/group/group__PJ__SEM>`
+  - :doc:`Lock <generated/pjlib/group/group__PJ__LOCK>`
+  - :doc:`Group Lock <generated/pjlib/group/group__PJ__GRP__LOCK>`
+  - :doc:`Event <generated/pjlib/group/group__PJ__EVENT>`
 
-- :doc:`Thread Local Storage <generated/generated/pjlib/group/group__PJ__TLS>`
+- :doc:`Thread Local Storage <generated/pjlib/group/group__PJ__TLS>`
 
 OS Abstraction
 ^^^^^^^^^^^^^^^^^
-- :doc:`OS Abstraction <generated/generated/pjlib/group/group__PJ__OS>`
+- :doc:`OS Abstraction <generated/pjlib/group/group__PJ__OS>`
 
-   - :doc:`Symbian OS Specific <generated/generated/pjlib/group/group__PJ__SYMBIAN__OS>`
+   - :doc:`Symbian OS Specific <generated/pjlib/group/group__PJ__SYMBIAN__OS>`
 
-- :doc:`System Information <generated/generated/pjlib/group/group__PJ__SYS__INFO>`
+- :doc:`System Information <generated/pjlib/group/group__PJ__SYS__INFO>`
 
 
 Time and Timer
 ^^^^^^^^^^^^^^^^^
-- :doc:`Time <generated/generated/pjlib/group/group__PJ__TIME>`
-- :doc:`High Resolution Timestamp <generated/generated/pjlib/group/group__PJ__TIMESTAMP>`
-- :doc:`Timer API <generated/generated/pjlib/group/group__PJ__TIMER>`
+- :doc:`Time <generated/pjlib/group/group__PJ__TIME>`
+- :doc:`High Resolution Timestamp <generated/pjlib/group/group__PJ__TIMESTAMP>`
+- :doc:`Timer API <generated/pjlib/group/group__PJ__TIMER>`
 
 
 Random and GUID 
 ^^^^^^^^^^^^^^^^^^^^^^
-- :doc:`Random <generated/generated/pjlib/group/group__PJ__RAND>`
-- :doc:`GUID <generated/generated/pjlib/group/group__PJ__GUID>`
+- :doc:`Random <generated/pjlib/group/group__PJ__RAND>`
+- :doc:`GUID <generated/pjlib/group/group__PJ__GUID>`
 
 
 Application Microframework
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
-- :doc:`main() <generated/generated/pjlib/group/group__PJ__APP__OS>`
+- :doc:`main() <generated/pjlib/group/group__PJ__APP__OS>`
 
 
diff --git a/docs/source/api/pjlib_util.rst b/docs/source/api/pjlib_util.rst
@@ -1,7 +1,7 @@
 PJLIB-UTIL
 =========================
 
-pilib_util is an auxiliary library providing adjunct functions to PJLIB.
+pjlib_util is an auxiliary library providing adjunct functions to PJLIB.
 
 
 
@@ -11,64 +11,64 @@ API Reference
 Basic Types and Functions
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-- :doc:`Basic Initialization <generated/pilib_util/group/group__PJLIB__UTIL__BASE>`
-- :doc:`Configurations <generated/pilib_util/group/group__PJLIB__UTIL__CONFIG>`
-- :doc:`Error Codes <generated/pilib_util/group/group__PJLIB__UTIL__ERROR>`
+- :doc:`Basic Initialization <generated/pjlib_util/group/group__PJLIB__UTIL__BASE>`
+- :doc:`Configurations <generated/pjlib_util/group/group__PJLIB__UTIL__CONFIG>`
+- :doc:`Error Codes <generated/pjlib_util/group/group__PJLIB__UTIL__ERROR>`
 
 
 Command-Line Interface (CLI) Framework
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-- :doc:`CLI Framework <generated/pilib_util/group/group__PJLIB__UTIL__CLI>`
-- :doc:`CLI Implementor API <generated/pilib_util/group/group__PJLIB__UTIL__CLI__IMP>`
+- :doc:`CLI Framework <generated/pjlib_util/group/group__PJLIB__UTIL__CLI>`
+- :doc:`CLI Implementor API <generated/pjlib_util/group/group__PJLIB__UTIL__CLI__IMP>`
 
 
 Encoding and Encryptions
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-- :doc:`Base64 Encoding/Decoding <generated/pilib_util/group/group__PJLIB__UTIL__BASE64>`
-- :doc:`CRC32 (Cyclic Redundancy Check) <generated/pilib_util/group/group__PJLIB__UTIL__CRC32>`
-- :doc:`HMAC MD5 Message Authentication <generated/pilib_util/group/group__PJLIB__UTIL__HMAC__MD5>`
-- :doc:`HMAC SHA1 Message Authentication <generated/pilib_util/group/group__PJLIB__UTIL__HMAC__SHA1>`
-- :doc:`MD5 <generated/pilib_util/group/group__PJLIB__UTIL__MD5>`
-- :doc:`SHA1 <generated/pilib_util/group/group__PJLIB__UTIL__SHA1>`
+- :doc:`Base64 Encoding/Decoding <generated/pjlib_util/group/group__PJLIB__UTIL__BASE64>`
+- :doc:`CRC32 (Cyclic Redundancy Check) <generated/pjlib_util/group/group__PJLIB__UTIL__CRC32>`
+- :doc:`HMAC MD5 Message Authentication <generated/pjlib_util/group/group__PJLIB__UTIL__HMAC__MD5>`
+- :doc:`HMAC SHA1 Message Authentication <generated/pjlib_util/group/group__PJLIB__UTIL__HMAC__SHA1>`
+- :doc:`MD5 <generated/pjlib_util/group/group__PJLIB__UTIL__MD5>`
+- :doc:`SHA1 <generated/pjlib_util/group/group__PJLIB__UTIL__SHA1>`
 
 
 Text and Strings
 ^^^^^^^^^^^^^^^^^^^^^^^^^
 
-- :doc:`Getopt <generated/pilib_util/group/group__PJLIB__UTIL__GETOPT>`
-- :doc:`Fast Text Scanner <generated/pilib_util/group/group__PJ__SCAN>`
-- :doc:`String Escaping Utilities <generated/pilib_util/group/group__PJLIB__UTIL__STRING>`
+- :doc:`Getopt <generated/pjlib_util/group/group__PJLIB__UTIL__GETOPT>`
+- :doc:`Fast Text Scanner <generated/pjlib_util/group/group__PJ__SCAN>`
+- :doc:`String Escaping Utilities <generated/pjlib_util/group/group__PJLIB__UTIL__STRING>`
 
 
 DNS 
 ^^^^^^^^^^^^^^^^^^^^^^^^^
 
-- :doc:`Low-level DNS Message Parsing and Packetization <generated/pilib_util/group/group__PJ__DNS__PARSING>`
-- :doc:`Simple DNS Server <generated/pilib_util/group/group__PJ__DNS__SERVER>`
-- :doc:`DNS Asynchronous/Caching Resolution Engine <generated/pilib_util/group/group__PJ__DNS__RESOLVER>`
-- :doc:`DNS SRV Resolution Helper <generated/pilib_util/group/group__PJ__DNS__SRV__RESOLVER>`
+- :doc:`Low-level DNS Message Parsing and Packetization <generated/pjlib_util/group/group__PJ__DNS__PARSING>`
+- :doc:`Simple DNS Server <generated/pjlib_util/group/group__PJ__DNS__SERVER>`
+- :doc:`DNS Asynchronous/Caching Resolution Engine <generated/pjlib_util/group/group__PJ__DNS__RESOLVER>`
+- :doc:`DNS SRV Resolution Helper <generated/pjlib_util/group/group__PJ__DNS__SRV__RESOLVER>`
 
 
 HTTP
 ^^^^^^^^^^^^^^^^^^^^^^^^^
 
-- :doc:`Simple HTTP Client <generated/pilib_util/group/group__PJ__HTTP__CLIENT>`
+- :doc:`Simple HTTP Client <generated/pjlib_util/group/group__PJ__HTTP__CLIENT>`
 
 
 STUN
 ^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Note: There is a better STUN client implementation is in PJNATH.
 
-- :doc:`STUN - Simple Helper <generated/pilib_util/group/group__PJLIB__UTIL__STUN__CLIENT>`
+- :doc:`STUN - Simple Helper <generated/pjlib_util/group/group__PJLIB__UTIL__STUN__CLIENT>`
 
 
 File Formats
 ^^^^^^^^^^^^^^^^^^^^^^^^^
 
-- :doc:`JSON - Reader and Writer <generated/pilib_util/group/group__PJ__JSON>`
-- :doc:`PCAP - Simple Reader <generated/pilib_util/group/group__PJ__PCAP>`
-- :doc:`XML - Tiny Parser/Helper <generated/pilib_util/group/group__PJ__TINY__XML>`
+- :doc:`JSON - Reader and Writer <generated/pjlib_util/group/group__PJ__JSON>`
+- :doc:`PCAP - Simple Reader <generated/pjlib_util/group/group__PJ__PCAP>`
+- :doc:`XML - Tiny Parser/Helper <generated/pjlib_util/group/group__PJ__TINY__XML>`
 
diff --git a/docs/source/api/pjsua2.rst b/docs/source/api/pjsua2.rst
@@ -1,6 +1,6 @@
 
 
-PJSUA2 - C++/Android/iOS/Py
+PJSUA2 - C++/Android/iOS/Python
 ****************************
 
 endpoint.hpp

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -33,15 +33,15 @@
             sys.exit(rc)
 
         api_dir = 'pjlib_util' if doxy_dir=='pjlib-util' else doxy_dir
-        cmd = f'breathe-apidoc -f -g file,group -p {api_dir} ' \
+        cmd = f'breathe-apidoc -f -g group -p {api_dir} ' \
               f'-o api{os.sep}generated{os.sep}{api_dir} ' \
               f'pjproject{os.sep}{doxy_dir}{os.sep}docs{os.sep}xml'
         print(f'==> {cmd}')
         rc = subprocess.call(cmd, shell=True)
         if rc:
             sys.exit(rc)
 
-        files = ['filelist.rst', 'grouplist.rst', 'structlist.rst', 'unionlist.rst']
+        files = ['filelist.rst', 'grouplist', 'structlist.rst', 'unionlist.rst']
         for f in files:
             try:
                 os.remove(f'api{os.sep}generated{os.sep}{api_dir}{os.sep}{f}')

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -44,19 +44,6 @@ PJPROJECT Online Documentation
 
 
 
-.. toctree::
-   :maxdepth: 1
-   :caption: Header Files:
-
-   api/pjsua2_files
-   api/pjsua_lib_files
-   api/pjsip_files
-   api/pjmedia_files
-   api/pjnath_files
-   api/pjlib_util_files
-   api/pjlib_files
-
-
 
 Indices and tables
 ==================